From 79ae1d51f8460079b104038b86923aa15925ee9e Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 05:46:59 +0100 Subject: [PATCH 01/20] feat: keep contacts on the device, search them offline and queue edits --- lib/store/__tests__/contacts.test.ts | 660 +++++++++++++++++++ lib/store/__tests__/helpers/fake-contacts.ts | 229 +++++++ lib/store/__tests__/helpers/fake-jmap.ts | 6 +- lib/store/area.ts | 2 + lib/store/areas.ts | 3 +- lib/store/contacts/index.ts | 27 + lib/store/contacts/methods.ts | 209 ++++++ lib/store/contacts/patch.ts | 88 +++ lib/store/contacts/pending.ts | 459 +++++++++++++ lib/store/contacts/records.ts | 116 ++++ lib/store/contacts/schema.ts | 75 +++ lib/store/contacts/sync.ts | 179 +++++ lib/store/engine/account-engine.ts | 2 + 13 files changed, 2051 insertions(+), 4 deletions(-) create mode 100644 lib/store/__tests__/contacts.test.ts create mode 100644 lib/store/__tests__/helpers/fake-contacts.ts create mode 100644 lib/store/contacts/index.ts create mode 100644 lib/store/contacts/methods.ts create mode 100644 lib/store/contacts/patch.ts create mode 100644 lib/store/contacts/pending.ts create mode 100644 lib/store/contacts/records.ts create mode 100644 lib/store/contacts/schema.ts create mode 100644 lib/store/contacts/sync.ts diff --git a/lib/store/__tests__/contacts.test.ts b/lib/store/__tests__/contacts.test.ts new file mode 100644 index 000000000..526595a85 --- /dev/null +++ b/lib/store/__tests__/contacts.test.ts @@ -0,0 +1,660 @@ +// @vitest-environment node +import { describe, expect, it } from 'vitest'; +import { mkdtempSync, rmSync } from 'node:fs'; +import os from 'node:os'; +import path from 'node:path'; +import { textFilter } from '@/lib/jmap/search-utils'; +import { DEFAULT_SCOPE, type StoreEvent } from '../area'; +import { contactsArea } from '../contacts'; +import { applyPatch, mergePatches } from '../contacts/patch'; +import { AccountEngine } from '../engine/account-engine'; +import type { MethodCall } from '../engine/transport'; +import type { StorageAdapter } from '../storage'; +import { JMAP_ACCOUNT } from './helpers/fake-jmap'; +import { CONTACTS_SESSION, FakeContacts, MAIL_ONLY_ACCOUNT, SHARED_ACCOUNT } from './helpers/fake-contacts'; +import { openFileStore, openMemoryStore } from './helpers/node-adapter'; + +function engineFor(server: FakeContacts, db: StorageAdapter = openMemoryStore(), emit?: (e: StoreEvent) => void) { + return new AccountEngine({ + account: 'a@fake.test', + db, + session: CONTACTS_SESSION, + transport: server, + areas: [contactsArea], + scope: DEFAULT_SCOPE, + emit, + now: () => Date.UTC(2026, 10, 3), + sleep: async () => {}, + }); +} + +async function synced(server: FakeContacts) { + const db = openMemoryStore(); + const engine = engineFor(server, db); + await engine.requestSync(); + return { db, engine }; +} + +function count(db: StorageAdapter, table: string): number { + return Number(db.get<{ n: number }>(`SELECT COUNT(*) AS n FROM ${table}`)?.n); +} + +/* eslint-disable @typescript-eslint/no-explicit-any -- answers are shaped like the server's */ +async function call(engine: AccountEngine, name: string, args: Record): Promise { + const response = await engine.answer([[name, { accountId: JMAP_ACCOUNT, ...args }, '0']]); + if (!response) throw new Error('nothing answered'); + const [answered, result] = response.methodResponses[0]; + if (answered === 'error') throw new Error(result.type); + return result; +} + +/** The client's searchContacts: its filter, limit 50, then a get on the query's ids. */ +async function search(engine: AccountEngine, query: string, accountId = JMAP_ACCOUNT): Promise { + const calls: MethodCall[] = [ + ['ContactCard/query', { accountId, filter: textFilter(query), limit: 50 }, '0'], + ['ContactCard/get', { accountId, '#ids': { resultOf: '0', name: 'ContactCard/query', path: '/ids' } }, '1'], + ]; + const response = await engine.answer(calls); + return (response?.methodResponses[1][1].list as Array<{ name: { full: string } }>).map((c) => c.name.full); +} + +function setCalls(server: FakeContacts): Array> { + return server.calls.filter(([name]) => name === 'ContactCard/set').map(([, args]) => args as Record); +} + +describe('contacts sync', () => { + it('pages every card of every account with the capability, and only those', async () => { + const server = new FakeContacts(); + server.addBook({ id: 'teambook', name: 'Team' }, SHARED_ACCOUNT); + for (let i = 0; i < 2345; i += 1) server.addCard(); + server.addCard({ id: 'c1', name: { full: 'Same id in the shared account' } }, SHARED_ACCOUNT); + server.addCard({}, MAIL_ONLY_ACCOUNT); + const { db } = await synced(server); + + expect(Number(db.get<{ n: number }>('SELECT COUNT(*) AS n FROM contact_card WHERE jmap = ?', [JMAP_ACCOUNT])?.n)).toBe(2345); + expect(Number(db.get<{ n: number }>('SELECT COUNT(*) AS n FROM contact_card WHERE jmap = ?', [SHARED_ACCOUNT])?.n)).toBe(1); + expect(Number(db.get<{ n: number }>('SELECT COUNT(*) AS n FROM contact_card WHERE jmap = ?', [MAIL_ONLY_ACCOUNT])?.n)).toBe(0); + // Same id in two accounts stays two cards. + const names = db.all<{ json: string }>("SELECT json FROM contact_card WHERE id = 'c1' ORDER BY jmap").map((r) => (JSON.parse(r.json) as { name: { full: string } }).name.full); + expect(names).toHaveLength(2); + for (const [name, args] of server.calls) { + if (name === 'ContactCard/query') expect(args.limit).toBeLessThanOrEqual(500); + } + }); + + it('continues a stopped full sync from its cursor after a reload', async () => { + const dir = mkdtempSync(path.join(os.tmpdir(), 'store-contacts-')); + try { + const file = path.join(dir, 's.db'); + const server = new FakeContacts(); + for (let i = 0; i < 2600; i += 1) server.addCard(); + const first = openFileStore(file); + const engine = engineFor(server, first); + let queries = 0; + server.beforeRequest = () => { + queries += 1; + // The address book call and the state capture, then one page of 2000: the network goes. + if (queries === 4) server.offline = true; + }; + await engine.requestSync(); + await engine.close(); + expect(count(first, 'contact_card')).toBe(2000); + first.close(); + + server.offline = false; + server.beforeRequest = null; + server.calls.length = 0; + const second = openFileStore(file); + await engineFor(server, second).requestSync(); + expect(count(second, 'contact_card')).toBe(2600); + const positions = server.calls.filter(([name]) => name === 'ContactCard/query').map(([, args]) => args.position); + expect(positions[0]).toBe(2000); + second.close(); + } finally { + rmSync(dir, { recursive: true, force: true }); + } + }); + + it('applies created, updated and destroyed cards as deltas, across pages', async () => { + const server = new FakeContacts(); + const a = server.addCard({ name: { full: 'Anna' } }); + const b = server.addCard({ name: { full: 'Bernd' } }); + const { db, engine } = await synced(server); + server.calls.length = 0; + + for (let i = 0; i < 1200; i += 1) server.addCard(); + server.editCard(a.id, { name: { full: 'Anna Neu' } }); + server.removeCard(b.id); + await engine.requestSync(); + + expect(server.calls.filter(([name]) => name === 'ContactCard/changes').length).toBeGreaterThan(1); + expect(server.calls.some(([name]) => name === 'ContactCard/query')).toBe(false); + expect(count(db, 'contact_card')).toBe(1201); + expect(await search(engine, 'anna')).toEqual(['Anna Neu']); + expect(await search(engine, 'bernd')).toEqual([]); + }); + + it('follows address book changes', async () => { + const server = new FakeContacts(); + const { engine } = await synced(server); + server.addBook({ id: 'book2', name: 'Work' }); + await engine.requestSync(); + expect(server.calls.some(([name]) => name === 'AddressBook/changes')).toBe(true); + const books = await call(engine, 'AddressBook/get', {}); + expect(books.list.map((b: { id: string }) => b.id).sort()).toEqual(['book1', 'book2']); + }); + + it('starts over when the server can no longer give changes, and drops what it no longer has', async () => { + const server = new FakeContacts(); + const gone = server.addCard({ name: { full: 'Gone' } }); + const kept = server.addCard({ name: { full: 'Kept' } }); + const { db, engine } = await synced(server); + server.removeCard(gone.id); + server.account().coll.ContactCard.truncatedBelow = server.account().coll.ContactCard.log.length; + await engine.requestSync(); + expect(db.all('SELECT id FROM contact_card').map((r) => r.id)).toEqual([kept.id]); + }); + + it('keeps a queued create through a resync', async () => { + const server = new FakeContacts(); + server.addCard(); + const { db, engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Offline' }, addressBookIds: { book1: true } } } }); + // The create can't go out yet, and the sweep of a full sync must not take + // it for something the server deleted. + server.refuse.set(created.n.uid, { type: 'serverFail' }); + db.run("UPDATE sync_state SET state = 'bad state!' WHERE type = 'ContactCard'"); + await engine.requestSync(); + expect(await search(engine, 'offline')).toEqual(['Offline']); + server.refuse.clear(); + await engine.requestSync(); + expect(await search(engine, 'offline')).toEqual(['Offline']); + expect([...server.account().cards.values()].filter((c) => (c.name as { full: string }).full === 'Offline')).toHaveLength(1); + }); +}); + +describe('contact answers', () => { + it('says so instead of answering empty when nothing was synced yet', async () => { + const engine = engineFor(new FakeContacts()); + const response = await engine.answer([['ContactCard/query', { accountId: JMAP_ACCOUNT, limit: 50 }, '0'], ['AddressBook/get', { accountId: JMAP_ACCOUNT }, '1']]); + expect(response).toBeNull(); + }); + + it('gives the last server state, never a made-up one, and asked-for properties only', async () => { + const server = new FakeContacts(); + const card = server.addCard(); + const { engine } = await synced(server); + const got = await call(engine, 'ContactCard/get', { ids: [card.id, 'nope'], properties: ['uid'] }); + expect(got.state).toBe(server.account().coll.ContactCard.state()); + expect(got.list).toEqual([{ id: card.id, uid: card.uid }]); + expect(got.notFound).toEqual(['nope']); + const books = await call(engine, 'AddressBook/get', { properties: ['name'] }); + expect(books.state).toBe(server.account().coll.AddressBook.state()); + expect(books.list).toEqual([{ id: 'book1', name: 'book1' }]); + }); + + it('pages a query with total and filters by address book', async () => { + const server = new FakeContacts(); + server.addBook({ id: 'book2', name: 'Work' }); + for (let i = 0; i < 5; i += 1) server.addCard({ addressBookIds: { book1: true } }); + server.addCard({ addressBookIds: { book2: true } }); + const { engine } = await synced(server); + const page = await call(engine, 'ContactCard/query', { position: 2, limit: 2, calculateTotal: true }); + expect(page.ids).toHaveLength(2); + expect(page.position).toBe(2); + expect(page.total).toBe(6); + const work = await call(engine, 'ContactCard/query', { filter: { inAddressBook: 'book2' } }); + expect(work.ids).toHaveLength(1); + }); + + it('refuses a filter it cannot read, for that call only', async () => { + const server = new FakeContacts(); + server.addCard(); + const { engine } = await synced(server); + const response = await engine.answer([ + ['ContactCard/query', { accountId: JMAP_ACCOUNT, filter: { phone: '123' } }, '0'], + ['AddressBook/get', { accountId: JMAP_ACCOUNT }, '1'], + ]); + expect(response?.methodResponses[0][0]).toBe('error'); + expect(response?.methodResponses[0][1].type).toBe('unsupportedFilter'); + expect(response?.methodResponses[1][0]).toBe('AddressBook/get'); + }); +}); + +describe('autocomplete', () => { + async function people() { + const server = new FakeContacts(); + server.addCard({ + name: { full: 'Jörg Müller-Lüdenscheidt', components: [{ kind: 'given', value: 'Jörg' }, { kind: 'surname', value: 'Müller-Lüdenscheidt' }] }, + emails: { e: { address: 'joerg.mueller@example.org' } }, + organizations: { o: { name: 'Bäckerei Straße', units: [{ name: 'Backstube' }] } }, + }); + server.addCard({ name: { full: 'Johannes Weiß' }, emails: { e: { address: 'jw@firma.example' } } }); + server.addCard({ name: { full: 'José Ñandú' }, nicknames: { n: { name: 'Pepe' } } }); + server.addCard({ name: { components: [{ kind: 'given', value: 'Hartmann' }] }, emails: { e: { address: 'h@x.example' } } }); + server.addCard({ name: { full: 'Käthe Schön' } }); + return synced(server); + } + + it.each([ + ['Müller', 'Jörg Müller-Lüdenscheidt'], + ['müll', 'Jörg Müller-Lüdenscheidt'], + ['MÜLLER', 'Jörg Müller-Lüdenscheidt'], + ['muller', 'Jörg Müller-Lüdenscheidt'], + ['mueller', 'Jörg Müller-Lüdenscheidt'], + ['joerg', 'Jörg Müller-Lüdenscheidt'], + ['lüden', 'Jörg Müller-Lüdenscheidt'], + ['bäck', 'Jörg Müller-Lüdenscheidt'], + ['strasse', 'Jörg Müller-Lüdenscheidt'], + ['Straße', 'Jörg Müller-Lüdenscheidt'], + ['backstube', 'Jörg Müller-Lüdenscheidt'], + ['schoen', 'Käthe Schön'], + ['kaethe', 'Käthe Schön'], + ['schon', 'Käthe Schön'], + ['SCHÖN', 'Käthe Schön'], + ['hannes', 'Johannes Weiß'], + ['weiss', 'Johannes Weiß'], + ['firma', 'Johannes Weiß'], + ['jw@firma', 'Johannes Weiß'], + ['jose', 'José Ñandú'], + ['nandu', 'José Ñandú'], + ['pepe', 'José Ñandú'], + ['jö mül', 'Jörg Müller-Lüdenscheidt'], + ['"Jörg Müller"', 'Jörg Müller-Lüdenscheidt'], + ['jö', null], + ['jo*', null], + ])('finds %s', async (query, expected) => { + const { engine } = await people(); + const found = await search(engine, query); + if (expected) expect(found).toEqual([expected]); + else expect(found.length).toBeGreaterThan(1); + }); + + it('does not match words that only share a start with another card', async () => { + const { engine } = await people(); + expect(await search(engine, 'mül weiß')).toEqual([]); + expect(await search(engine, 'xyz')).toEqual([]); + expect(await search(engine, '*')).toEqual([]); + }); + + it('finds a card by a component when it has no full name', async () => { + const { db, engine } = await people(); + expect(await call(engine, 'ContactCard/query', { filter: { text: 'hart' } })).toMatchObject({ ids: [expect.any(String)] }); + expect(db.get<{ sort_key: string }>("SELECT sort_key FROM contact_card WHERE json LIKE '%Hartmann%'")?.sort_key).toBe('hartmann'); + }); + + it('lists names starting with the text before names containing it, and stops at the limit', async () => { + const server = new FakeContacts(); + for (let i = 0; i < 60; i += 1) server.addCard({ name: { full: `Aanna ${String(i).padStart(2, '0')}` } }); + server.addCard({ name: { full: 'Zoe Anna' } }); + const { engine } = await synced(server); + const found = await search(engine, 'anna'); + expect(found).toHaveLength(50); + expect(found[0]).toBe('Zoe Anna'); + }); + + it('keeps accounts apart', async () => { + const server = new FakeContacts(); + server.addCard({ name: { full: 'Own Person' } }); + server.addBook({ id: 'teambook', name: 'Team' }, SHARED_ACCOUNT); + server.addCard({ name: { full: 'Team Person' } }, SHARED_ACCOUNT); + const { engine } = await synced(server); + expect(await search(engine, 'person')).toEqual(['Own Person']); + expect(await search(engine, 'person', SHARED_ACCOUNT)).toEqual(['Team Person']); + }); + + it('finds the new name and not the old after an edit is queued', async () => { + const server = new FakeContacts(); + const card = server.addCard({ name: { full: 'Oldname' } }); + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { update: { [card.id]: { name: { full: 'Newname' } } } }); + expect(await search(engine, 'newname')).toEqual(['Newname']); + expect(await search(engine, 'oldname')).toEqual([]); + }); +}); + +describe('patches', () => { + it('applies pointers and removes on null, leaving the original alone', () => { + const card = { name: { full: 'A', given: 'B' }, note: 'x' }; + const out = applyPatch(card, { 'name/full': 'C', note: null, 'a~1b': 1 }); + expect(out).toEqual({ name: { full: 'C', given: 'B' }, 'a/b': 1 }); + expect(card.name.full).toBe('A'); + expect(() => applyPatch(card, { 'missing/x': 1 })).toThrow(); + }); + + it('merges: newer wins, a whole property replaces what is below it, a path goes into an older whole value', () => { + expect(mergePatches({ a: 1, b: 2 }, { b: 3 })).toEqual({ a: 1, b: 3 }); + expect(mergePatches({ 'name/full': 'A', 'name/given': 'B' }, { name: { full: 'C' } })).toEqual({ name: { full: 'C' } }); + expect(mergePatches({ name: { full: 'A', given: 'B' } }, { 'name/full': 'C' })).toEqual({ name: { full: 'C', given: 'B' } }); + expect(mergePatches({ note: 'x' }, { note: null })).toEqual({ note: null }); + }); +}); + +describe('queued edits', () => { + it('merges edits per card, and sends one patch after coming back', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old', name: { full: 'Anna' } }); + const { db, engine } = await synced(server); + server.offline = true; + engine.setOnline(false); + + await call(engine, 'ContactCard/set', { update: { [card.id]: { note: 'first' } } }); + await call(engine, 'ContactCard/set', { update: { [card.id]: { note: 'second', 'name/full': 'Anna B' } } }); + await call(engine, 'ContactCard/set', { update: { [card.id]: { 'name/full': 'Anna C' } } }); + expect(count(db, 'contact_pending')).toBe(1); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(1); + const seen = await call(engine, 'ContactCard/get', { ids: [card.id] }); + expect(seen.list[0]).toMatchObject({ note: 'second', name: { full: 'Anna C' } }); + + server.offline = false; + engine.setOnline(true); + await engine.areaCall('contacts.flush', undefined); + const sets = setCalls(server); + expect(sets).toHaveLength(1); + expect(sets[0].update[card.id]).toEqual({ note: 'second', 'name/full': 'Anna C' }); + expect(server.account().cards.get(card.id)).toMatchObject({ note: 'second', name: { full: 'Anna C' } }); + expect(count(db, 'contact_pending')).toBe(0); + }); + + it('lets stand-in ids work in later edits and sends one create', async () => { + const server = new FakeContacts(); + const { db, engine } = await synced(server); + engine.setOnline(false); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Neu' }, addressBookIds: { book1: true } } } }); + const standIn = created.n.id; + expect(created.n.uid).toMatch(/^urn:uuid:/); + + const fetched = await call(engine, 'ContactCard/get', { ids: [standIn] }); + expect(fetched.list[0]).toMatchObject({ id: standIn, name: { full: 'Neu' }, uid: created.n.uid }); + const updated = await call(engine, 'ContactCard/set', { update: { [standIn]: { note: 'added' } } }); + expect(updated.updated).toEqual({ [standIn]: null }); + + engine.setOnline(true); + await engine.requestSync(); + const sets = setCalls(server); + expect(sets).toHaveLength(1); + const sent = Object.values(sets[0].create)[0] as Record; + expect(sent).toMatchObject({ name: { full: 'Neu' }, note: 'added', uid: created.n.uid }); + expect(sent).not.toHaveProperty('id'); + const onServer = [...server.account().cards.values()]; + expect(onServer).toHaveLength(1); + + // The page may still hold the stand-in id: it finds the card, and can edit it. + const late = await call(engine, 'ContactCard/get', { ids: [standIn] }); + expect(late.list[0].id).toBe(onServer[0].id); + expect(db.get('SELECT 1 AS x FROM contact_card WHERE id = ?', [standIn])).toBeUndefined(); + expect(count(db, 'contact_card')).toBe(1); + engine.setOnline(false); + await call(engine, 'ContactCard/set', { update: { [standIn]: { note: 'later' } } }); + engine.setOnline(true); + await engine.requestSync(); + expect(server.account().cards.get(onServer[0].id)).toMatchObject({ note: 'later' }); + }); + + it('never sends a card created and deleted while offline', async () => { + const server = new FakeContacts(); + const { db, engine } = await synced(server); + engine.setOnline(false); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Short' }, addressBookIds: { book1: true } } } }); + const gone = await call(engine, 'ContactCard/set', { destroy: [created.n.id] }); + expect(gone.destroyed).toEqual([created.n.id]); + engine.setOnline(true); + await engine.requestSync(); + expect(setCalls(server)).toHaveLength(0); + expect(count(db, 'contact_card')).toBe(0); + }); + + it('hides a queued delete, also from sync, then deletes on the server', async () => { + const server = new FakeContacts(); + const card = server.addCard(); + const { db, engine } = await synced(server); + engine.setOnline(false); + await call(engine, 'ContactCard/set', { destroy: [card.id] }); + expect((await call(engine, 'ContactCard/get', { ids: [card.id] })).notFound).toEqual([card.id]); + const again = await call(engine, 'ContactCard/set', { destroy: [card.id], update: { [card.id]: { note: 'x' } } }); + expect(again.notDestroyed[card.id].type).toBe('notFound'); + expect(again.notUpdated[card.id].type).toBe('notFound'); + engine.setOnline(true); + await engine.requestSync(); + expect(server.account().cards.has(card.id)).toBe(false); + expect(count(db, 'contact_card')).toBe(0); + }); + + it('keeps a queued delete hidden when a full sync brings the card again', async () => { + const server = new FakeContacts(); + const card = server.addCard({ name: { full: 'Hidden' } }); + const { db, engine } = await synced(server); + await call(engine, 'ContactCard/set', { destroy: [card.id] }); + server.refuse.set(card.id, { type: 'serverFail' }); + db.run("UPDATE sync_state SET state = 'bad state!' WHERE type = 'ContactCard'"); + await engine.requestSync(); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(1); + expect(await search(engine, 'hidden')).toEqual([]); + server.refuse.clear(); + await engine.requestSync(); + expect(server.account().cards.has(card.id)).toBe(false); + }); + + it('keeps the queued edit on top when sync brings a newer card', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old', name: { full: 'Anna' } }); + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { update: { [card.id]: { note: 'mine' } } }); + // A pass with the flush step still to come: the row was already there, so the merge shows on the delta. + server.refuse.set(card.id, { type: 'serverFail' }); + server.editCard(card.id, { name: { full: 'Anna Server' } }); + await engine.requestSync(); + const seen = await call(engine, 'ContactCard/get', { ids: [card.id] }); + expect(seen.list[0]).toMatchObject({ note: 'mine', name: { full: 'Anna Server' } }); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(1); + server.refuse.clear(); + await engine.requestSync(); + expect(server.account().cards.get(card.id)).toMatchObject({ note: 'mine', name: { full: 'Anna Server' } }); + expect(await engine.areaCall('contacts.conflicts', undefined)).toEqual([]); + }); + + it('refuses a held upload as a photo, the way the client takes as a blob refusal', async () => { + const server = new FakeContacts(); + const card = server.addCard(); + const { engine } = await synced(server); + const result = await call(engine, 'ContactCard/set', { update: { [card.id]: { media: { p: { kind: 'photo', blobId: 'bulwark-local-123' } } } } }); + expect(result.notUpdated[card.id]).toMatchObject({ type: 'invalidProperties', properties: ['media'] }); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + }); + + it('refuses a card with no address book, since it could never be saved', async () => { + const server = new FakeContacts(); + const { engine } = await synced(server); + const result = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Nowhere' } } } }); + expect(result.notCreated.n).toMatchObject({ type: 'invalidProperties', properties: ['addressBookIds'] }); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + }); + + it('answers a patch that leads nowhere per record', async () => { + const server = new FakeContacts(); + const card = server.addCard(); + const { engine } = await synced(server); + const result = await call(engine, 'ContactCard/set', { update: { [card.id]: { 'nope/x': 1 } } }); + expect(result.notUpdated[card.id].type).toBe('invalidPatch'); + }); +}); + +describe('lost responses', () => { + it('finds the card by uid instead of creating it twice', async () => { + const server = new FakeContacts(); + // Without the refusal Stalwart gives, only the uid lookup can stop a second card. + server.allowDuplicateUids = true; + const { db, engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Once' }, addressBookIds: { book1: true } } } }); + + server.loseNextSet = true; + await engine.requestSync(); + expect(server.account().cards.size).toBe(1); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(1); + + await engine.requestSync(); + expect(server.account().cards.size).toBe(1); + expect(setCalls(server)).toHaveLength(1); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + const real = [...server.account().cards.keys()][0]; + expect(db.all('SELECT id FROM contact_card').map((r) => r.id)).toEqual([real]); + expect((await call(engine, 'ContactCard/get', { ids: [created.n.id] })).list[0].id).toBe(real); + }); + + it('takes the server refusing the uid as the card being there', async () => { + const server = new FakeContacts(); + const { engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Once' }, addressBookIds: { book1: true } } } }); + // The card reached the server by another way than this flush saw. + server.addCard({ uid: created.n.uid, name: { full: 'Once' } }); + await engine.requestSync(); + expect(server.account().cards.size).toBe(1); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + expect(await engine.areaCall('contacts.conflicts', undefined)).toEqual([]); + expect((await call(engine, 'ContactCard/query', {})).ids).toHaveLength(1); + }); + + it('does not take its own lost update for a change on the server', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old' }); + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { update: { [card.id]: { note: 'mine' } } }); + server.loseNextSet = true; + await engine.requestSync(); + expect(server.account().cards.get(card.id)).toMatchObject({ note: 'mine' }); + await engine.requestSync(); + expect(setCalls(server)).toHaveLength(1); + expect(await engine.areaCall('contacts.conflicts', undefined)).toEqual([]); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + }); + + it('keeps everything queued when the network fails, and a delete after a lost create still deletes', async () => { + const server = new FakeContacts(); + const { engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Twice' }, addressBookIds: { book1: true } } } }); + server.loseNextSet = true; + await engine.requestSync(); + expect(server.account().cards.size).toBe(1); + await call(engine, 'ContactCard/set', { destroy: [created.n.id] }); + await engine.requestSync(); + expect(server.account().cards.size).toBe(0); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + }); +}); + +describe('conflicts', () => { + it('records a refused create and takes it out of the answers', async () => { + const server = new FakeContacts(); + const { engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Refused' }, addressBookIds: { book1: true } } } }); + const uid = created.n.uid; + server.refuse.set(uid, { type: 'forbidden', description: 'No rights here' }); + await engine.requestSync(); + const conflicts = await engine.areaCall('contacts.conflicts', undefined) as Array>; + expect(conflicts).toHaveLength(1); + expect(conflicts[0]).toMatchObject({ kind: 'refused', summary: 'Refused', error: 'forbidden: No rights here', jmap: JMAP_ACCOUNT, local: { op: 'create' } }); + expect(await search(engine, 'refused')).toEqual([]); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + }); + + it('records a refused update and goes back to the server copy', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'server' }); + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { update: { [card.id]: { note: 'mine' } } }); + server.refuse.set(card.id, { type: 'forbidden' }); + await engine.requestSync(); + const conflicts = await engine.areaCall('contacts.conflicts', undefined) as Array>; + expect(conflicts[0]).toMatchObject({ kind: 'refused', recordId: card.id, local: { op: 'update', payload: { note: 'mine' } } }); + expect((await call(engine, 'ContactCard/get', { ids: [card.id] })).list[0].note).toBe('server'); + await engine.areaCall('contacts.dismissConflict', { id: conflicts[0].id }); + expect(await engine.areaCall('contacts.conflicts', undefined)).toEqual([]); + }); + + it('records an edit to a property the server changed too, and does not overwrite it', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old' }); + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { update: { [card.id]: { note: 'mine' } } }); + server.editCard(card.id, { note: 'theirs' }); + await engine.requestSync(); + const conflicts = await engine.areaCall('contacts.conflicts', undefined) as Array>; + expect(conflicts).toHaveLength(1); + expect(conflicts[0]).toMatchObject({ kind: 'changed', local: { payload: { note: 'mine' } }, server: { note: 'theirs' } }); + expect(setCalls(server)).toHaveLength(0); + expect(server.account().cards.get(card.id)?.note).toBe('theirs'); + expect((await call(engine, 'ContactCard/get', { ids: [card.id] })).list[0].note).toBe('theirs'); + }); + + it('sends an edit when the server only changed other properties', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old', name: { full: 'A' } }); + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { update: { [card.id]: { note: 'mine' } } }); + server.editCard(card.id, { name: { full: 'B' } }); + await engine.requestSync(); + expect(await engine.areaCall('contacts.conflicts', undefined)).toEqual([]); + expect(server.account().cards.get(card.id)).toMatchObject({ note: 'mine', name: { full: 'B' } }); + }); + + it('records an edit to a card deleted on the server', async () => { + const server = new FakeContacts(); + const card = server.addCard({ name: { full: 'Vanished' } }); + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { update: { [card.id]: { note: 'mine' } } }); + server.removeCard(card.id); + await engine.requestSync(); + const conflicts = await engine.areaCall('contacts.conflicts', undefined) as Array>; + expect(conflicts).toHaveLength(1); + expect(conflicts[0]).toMatchObject({ kind: 'gone', summary: 'Vanished', recordId: card.id }); + expect(await search(engine, 'vanished')).toEqual([]); + }); + + it('does not delete a card that changed on the server since the delete was queued', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old', name: { full: 'Keep me' } }); + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { destroy: [card.id] }); + server.editCard(card.id, { note: 'someone cares' }); + await engine.requestSync(); + expect(server.account().cards.has(card.id)).toBe(true); + expect(await search(engine, 'keep')).toEqual(['Keep me']); + const conflicts = await engine.areaCall('contacts.conflicts', undefined) as Array>; + expect(conflicts[0]).toMatchObject({ kind: 'changed', local: { op: 'destroy' } }); + }); + + it('does not count a delete of a card already gone as a conflict', async () => { + const server = new FakeContacts(); + const card = server.addCard(); + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { destroy: [card.id] }); + server.removeCard(card.id); + await engine.requestSync(); + expect(await engine.areaCall('contacts.conflicts', undefined)).toEqual([]); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + }); +}); + +describe('edits while sending', () => { + it('keeps an edit made while the create was on its way', async () => { + const server = new FakeContacts(); + const { engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Racing' }, note: 'one', addressBookIds: { book1: true } } } }); + let edited = false; + const original = server.request.bind(server); + server.request = async (calls: MethodCall[]) => { + if (!edited && calls.some(([name]) => name === 'ContactCard/set')) { + edited = true; + await call(engine, 'ContactCard/set', { update: { [created.n.id]: { note: 'two' } } }); + } + return original(calls); + }; + await engine.requestSync(); + await engine.requestSync(); + const cards = [...server.account().cards.values()]; + expect(cards).toHaveLength(1); + expect(cards[0].note).toBe('two'); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + }); +}); +/* eslint-enable @typescript-eslint/no-explicit-any */ diff --git a/lib/store/__tests__/helpers/fake-contacts.ts b/lib/store/__tests__/helpers/fake-contacts.ts new file mode 100644 index 000000000..e6b408755 --- /dev/null +++ b/lib/store/__tests__/helpers/fake-contacts.ts @@ -0,0 +1,229 @@ +/** + * FakeJmap with contacts, as measured on both Stalwarts (2026-11-03): uid is a + * query filter, a second card with a uid is refused with invalidProperties, + * unknown ids give per-record notFound, AddressBook state doesn't move when + * cards change, `ContactCard/get` with ids null stops at 500. + */ + +import { TransportError, type JmapResponse, type MethodCall, type StoreSession } from '../../engine/transport'; +import { Collection, FAKE_SESSION, FakeJmap, JMAP_ACCOUNT } from './fake-jmap'; + +export const CONTACTS = 'urn:ietf:params:jmap:contacts'; +export const SHARED_ACCOUNT = 'shared1'; +export const MAIL_ONLY_ACCOUNT = 'mailonly'; + +export const CONTACTS_SESSION: StoreSession = { + ...FAKE_SESSION, + primaryAccounts: { ...FAKE_SESSION.primaryAccounts, [CONTACTS]: JMAP_ACCOUNT }, + accounts: { + [JMAP_ACCOUNT]: { name: 'a@example.org', isPersonal: true, accountCapabilities: { [CONTACTS]: {} } }, + [SHARED_ACCOUNT]: { name: 'team@example.org', isPersonal: false, accountCapabilities: { [CONTACTS]: {} } }, + [MAIL_ONLY_ACCOUNT]: { name: 'list@example.org', isPersonal: false, accountCapabilities: { 'urn:ietf:params:jmap:mail': {} } }, + }, + capabilities: { [CONTACTS]: {} }, +}; + +type Obj = Record & { id: string }; + +/** The /changes rules of the base fake, for another collection. */ +export function changesFor(coll: Collection, args: Record): Record { + const since = String(args.sinceState); + if (!/^s\d+$/.test(since)) throw Object.assign(new Error('bad state'), { jmapError: 'invalidArguments' }); + const from = Number(since.slice(1)); + if (from < coll.truncatedBelow || from > coll.log.length) { + throw Object.assign(new Error('log truncated'), { jmapError: 'cannotCalculateChanges' }); + } + const maxChanges = Math.min(Number(args.maxChanges ?? 5000) || 5000, 5000); + return { accountId: args.accountId, oldState: since, ...coll.changes(since, maxChanges) }; +} + +function applyServerPatch(card: Obj, patch: Record): void { + for (const [path, value] of Object.entries(patch)) { + const steps = path.split('/'); + let node = card as Record; + for (const step of steps.slice(0, -1)) node = node[step] as Record; + const last = steps[steps.length - 1]; + if (value === null) delete node[last]; + else node[last] = value; + } +} + +class ContactAccount { + readonly books = new Map(); + readonly cards = new Map(); + readonly coll = { AddressBook: new Collection(), ContactCard: new Collection() }; +} + +export class FakeContacts extends FakeJmap { + private readonly contactAccounts = new Map(); + private nextCard = 1; + /** Set to apply the next ContactCard/set and then lose its response. */ + loseNextSet = false; + /** Card ids (or creation ids) whose next set is refused with this error. */ + readonly refuse = new Map(); + /** A server that lets two cards have one uid, as nothing in the RFC forbids it. */ + allowDuplicateUids = false; + + constructor(books: string[] = ['book1']) { + super(); + for (const id of books) this.addBook({ id, name: id, isDefault: id === books[0] }); + } + + account(id: string = JMAP_ACCOUNT): ContactAccount { + let found = this.contactAccounts.get(id); + if (!found) { + found = new ContactAccount(); + this.contactAccounts.set(id, found); + } + return found; + } + + addBook(book: Obj, accountId: string = JMAP_ACCOUNT): void { + const account = this.account(accountId); + account.books.set(book.id, book); + account.coll.AddressBook.push('created', book.id); + } + + addCard(partial: Partial = {}, accountId: string = JMAP_ACCOUNT): Obj { + const account = this.account(accountId); + const n = this.nextCard++; + const card: Obj = { + '@type': 'Card', + version: '1.0', + id: `c${n}`, + uid: `urn:uuid:card-${n}`, + addressBookIds: { [[...account.books.keys()][0] ?? 'book1']: true }, + kind: 'individual', + name: { full: `Person ${n}` }, + ...partial, + }; + account.cards.set(card.id, card); + account.coll.ContactCard.push('created', card.id); + return card; + } + + editCard(id: string, patch: Record, accountId: string = JMAP_ACCOUNT): void { + const account = this.account(accountId); + applyServerPatch(account.cards.get(id) as Obj, patch); + account.coll.ContactCard.push('updated', id); + } + + removeCard(id: string, accountId: string = JMAP_ACCOUNT): void { + const account = this.account(accountId); + account.cards.delete(id); + account.coll.ContactCard.push('destroyed', id); + } + + private contactSet(account: ContactAccount, args: Record): Record { + const result: Record = { accountId: args.accountId, oldState: account.coll.ContactCard.state() }; + const created: Record = {}; + const notCreated: Record = {}; + const updated: Record = {}; + const notUpdated: Record = {}; + const destroyed: string[] = []; + const notDestroyed: Record = {}; + for (const [cid, raw] of Object.entries((args.create ?? {}) as Record>)) { + const refused = this.refuse.get(cid) ?? this.refuse.get(String(raw.uid)); + const clash = [...account.cards.values()].find((card) => card.uid === raw.uid); + if (refused) { + notCreated[cid] = refused; + } else if (clash && !this.allowDuplicateUids) { + notCreated[cid] = { type: 'invalidProperties', description: `Contact with UID ${String(raw.uid)} already exists with id ${clash.id}.`, properties: ['uid'] }; + } else { + const id = `c${this.nextCard++}`; + account.cards.set(id, { '@type': 'Card', version: '1.0', ...raw, id }); + account.coll.ContactCard.push('created', id); + created[cid] = { id }; + } + } + for (const [id, patch] of Object.entries((args.update ?? {}) as Record>)) { + const card = account.cards.get(id); + const refused = this.refuse.get(id); + if (refused) notUpdated[id] = refused; + else if (!card) notUpdated[id] = { type: 'notFound' }; + else { + applyServerPatch(card, patch); + account.coll.ContactCard.push('updated', id); + updated[id] = null; + } + } + for (const id of (args.destroy ?? []) as string[]) { + const refused = this.refuse.get(id); + if (refused) notDestroyed[id] = refused; + else if (!account.cards.has(id)) notDestroyed[id] = { type: 'notFound' }; + else { + account.cards.delete(id); + account.coll.ContactCard.push('destroyed', id); + destroyed.push(id); + } + } + for (const [key, value] of Object.entries({ created, notCreated, updated, notUpdated, notDestroyed })) { + if (Object.keys(value).length > 0) result[key] = value; + } + if (destroyed.length > 0) result.destroyed = destroyed; + result.newState = account.coll.ContactCard.state(); + return result; + } + + protected override handle(name: string, args: Record): Record { + const account = this.account(String(args.accountId)); + switch (name) { + case 'AddressBook/get': { + const ids = args.ids as string[] | null | undefined; + const all = [...account.books.values()]; + return { + accountId: args.accountId, + state: account.coll.AddressBook.state(), + list: ids ? all.filter((b) => ids.includes(b.id)) : all, + notFound: ids ? ids.filter((id) => !account.books.has(id)) : [], + }; + } + case 'AddressBook/changes': + return changesFor(account.coll.AddressBook, args); + case 'ContactCard/changes': + return changesFor(account.coll.ContactCard, args); + case 'ContactCard/query': { + const filter = (args.filter ?? {}) as { uid?: string; inAddressBook?: string }; + let list = [...account.cards.values()]; + if (filter.uid) list = list.filter((c) => c.uid === filter.uid); + if (filter.inAddressBook) list = list.filter((c) => (c.addressBookIds as Record)[filter.inAddressBook as string]); + const position = Number(args.position ?? 0); + const limit = Number(args.limit ?? 5000) || 5000; + return { + accountId: args.accountId, + queryState: account.coll.ContactCard.state(), + canCalculateChanges: true, + position, + ids: list.slice(position, position + Math.min(limit, 5000)).map((c) => c.id), + ...(args.calculateTotal ? { total: list.length } : {}), + }; + } + case 'ContactCard/get': { + const ids = args.ids as string[] | null | undefined; + if (ids && ids.length > 500) throw Object.assign(new Error('requestTooLarge'), { jmapError: 'requestTooLarge' }); + const chosen = ids ?? [...account.cards.keys()].slice(0, 500); + return { + accountId: args.accountId, + state: account.coll.ContactCard.state(), + list: chosen.filter((id) => account.cards.has(id)).map((id) => structuredClone(account.cards.get(id))), + notFound: chosen.filter((id) => !account.cards.has(id)), + }; + } + case 'ContactCard/set': + return this.contactSet(account, args); + default: + return super.handle(name, args); + } + } + + override async request(calls: MethodCall[], using?: string[]): Promise { + // The real server fails the whole request for a capability it doesn't list. + void using; + const response = await super.request(calls); + if (this.loseNextSet && calls.some(([name]) => name === 'ContactCard/set')) { + this.loseNextSet = false; + throw new TransportError('network', 'Connection dropped after the server took the request'); + } + return response; + } +} diff --git a/lib/store/__tests__/helpers/fake-jmap.ts b/lib/store/__tests__/helpers/fake-jmap.ts index 9aa917be5..1fd274c04 100644 --- a/lib/store/__tests__/helpers/fake-jmap.ts +++ b/lib/store/__tests__/helpers/fake-jmap.ts @@ -25,7 +25,7 @@ type ChangeKind = 'created' | 'updated' | 'destroyed'; interface Log { kind: ChangeKind; id: string } -class Collection { +export class Collection { log: Log[] = []; /** Below this log position, states are refused as truncated. */ truncatedBelow = 0; @@ -169,7 +169,7 @@ export class FakeJmap implements JmapTransport { return list.map((e) => e.id); } - private handle(name: string, args: Record): Record { + protected handle(name: string, args: Record): Record { switch (name) { case 'Mailbox/get': { const ids = args.ids as string[] | null; @@ -275,7 +275,7 @@ export class FakeJmap implements JmapTransport { return { methodResponses: done }; } - async download(): Promise { + async download(_jmap: string, _blobId: string, _type: string, _name: string): Promise { return new Uint8Array(); } diff --git a/lib/store/area.ts b/lib/store/area.ts index fceed110e..9bd11fd35 100644 --- a/lib/store/area.ts +++ b/lib/store/area.ts @@ -52,6 +52,8 @@ export interface StoreContext { scope: StoreScope; now(): number; emit(event: StoreEvent): void; + /** Starts a sync pass, or one more after the running pass. Resolves when they're done. */ + requestSync(): Promise; } export interface SyncContext extends StoreContext { diff --git a/lib/store/areas.ts b/lib/store/areas.ts index 6bff665ca..c8882f3ee 100644 --- a/lib/store/areas.ts +++ b/lib/store/areas.ts @@ -1,6 +1,7 @@ /** Every part of the local store. New areas go here. */ import type { StoreArea } from './area'; +import { contactsArea } from './contacts'; import { mailArea } from './mail'; -export const STORE_AREAS: readonly StoreArea[] = [mailArea]; +export const STORE_AREAS: readonly StoreArea[] = [mailArea, contactsArea]; diff --git a/lib/store/contacts/index.ts b/lib/store/contacts/index.ts new file mode 100644 index 000000000..01b129a8a --- /dev/null +++ b/lib/store/contacts/index.ts @@ -0,0 +1,27 @@ +import type { StoreArea } from '../area'; +import { CONTACT_METHODS } from './methods'; +import { listConflicts, pendingCount } from './pending'; +import { CONTACT_MIGRATIONS } from './schema'; +import { contactsSyncer } from './sync'; + +export const contactsArea: StoreArea = { + name: 'contacts', + migrations: CONTACT_MIGRATIONS, + methods: CONTACT_METHODS, + syncers: [contactsSyncer], + calls: { + /** Sends what's queued, in the next sync pass, and says what's left. */ + 'contacts.flush': async (ctx) => { + await ctx.requestSync(); + return { pending: pendingCount(ctx.db), conflicts: listConflicts(ctx.db).length }; + }, + /** How many cards have edits waiting to go out. */ + 'contacts.pending': (ctx) => pendingCount(ctx.db), + /** Edits the server refused or that met a change there. The server's copy is the one kept. */ + 'contacts.conflicts': (ctx) => listConflicts(ctx.db), + /** The user has seen this one. */ + 'contacts.dismissConflict': (ctx, params: { id: number }) => { + ctx.db.run('DELETE FROM contact_conflict WHERE id = ?', [params.id]); + }, + }, +}; diff --git a/lib/store/contacts/methods.ts b/lib/store/contacts/methods.ts new file mode 100644 index 000000000..f3c885909 --- /dev/null +++ b/lib/store/contacts/methods.ts @@ -0,0 +1,209 @@ +/** Contact reads and queued edits, answered from the store. */ + +import { MethodError, type MethodContext, type MethodHandler, type MethodResult } from '../area'; +import { listObjects } from '../engine/core-schema'; +import type { SqlValue } from '../storage'; +import { queueCreate, queueDestroy, queueUpdate, resolveCardId, type SetError } from './pending'; +import { CONTACTS_CAPABILITY, foldText } from './records'; +import type { JsonObject, Patch } from './patch'; + +type Filter = Record; + +interface Sql { sql: string; params: SqlValue[] } + +function jmapOf(ctx: MethodContext, args: Record): string { + return (args.accountId as string | undefined) ?? ctx.session.primaryAccounts[CONTACTS_CAPABILITY] ?? ctx.defaultJmap; +} + +/** The last state from the server. Throws when this type was never synced, so an empty answer always means empty. */ +function syncedState(ctx: MethodContext, jmap: string, type: string): string | null { + const row = ctx.db.get<{ state: string | null; phase: string | null }>('SELECT state, phase FROM sync_state WHERE jmap = ? AND type = ?', [jmap, type]); + if (!row || (!row.state && !row.phase)) throw new MethodError('serverUnavailable', 'Contacts not kept yet'); + return row.state; +} + +function pick(object: Record, properties: unknown): Record { + if (!Array.isArray(properties)) return object; + const out: Record = { id: object.id }; + for (const property of properties as string[]) if (property in object) out[property] = object[property]; + return out; +} + +function quote(term: string): string { + return `"${term.replace(/"/g, '""')}"`; +} + +function terms(text: string): string[] { + return foldText(text).split(/[^\p{L}\p{N}]+/u).filter(Boolean); +} + +/** + * A `text` condition, one part of the client's textFilter (search-utils.ts): + * words, `word*` or a "quoted phrase". Every word has to match somewhere. The + * trigram index finds it anywhere in a name, which takes three characters. + * Shorter ones match the start of a word. + */ +function textCondition(value: string, rank: string[]): Sql { + const phrase = /^"(.+)"$/.exec(value.trim()); + const words = terms(phrase ? phrase[1] : value); + if (words.length === 0) return { sql: '0', params: [] }; + if (phrase) { + rank.push(quote(words.join(' '))); + return { sql: 'c.rowid IN (SELECT rowid FROM contact_fts_word WHERE contact_fts_word MATCH ?)', params: [quote(words.join(' '))] }; + } + const parts: string[] = []; + const params: SqlValue[] = []; + for (const word of words) { + rank.push(`${quote(word)}*`); + if ([...word].length >= 3) { + parts.push('c.rowid IN (SELECT rowid FROM contact_fts_tri WHERE contact_fts_tri MATCH ?)'); + params.push(quote(word)); + } else { + parts.push('c.rowid IN (SELECT rowid FROM contact_fts_word WHERE contact_fts_word MATCH ?)'); + params.push(`${quote(word)}*`); + } + } + return { sql: parts.join(' AND '), params }; +} + +function filterSql(filter: Filter, rank: string[]): Sql { + if (typeof filter.operator === 'string') { + const parts = (Array.isArray(filter.conditions) ? filter.conditions as Filter[] : []).map((c) => filterSql(c, rank)); + const params = parts.flatMap((p) => p.params); + const joined = (joiner: string) => parts.map((p) => `(${p.sql})`).join(joiner); + if (filter.operator === 'AND') return { sql: parts.length ? joined(' AND ') : '1', params }; + if (filter.operator === 'OR') return { sql: parts.length ? joined(' OR ') : '0', params }; + if (filter.operator === 'NOT') return { sql: parts.length ? `NOT (${joined(' OR ')})` : '1', params }; + throw new MethodError('unsupportedFilter', `Unknown operator ${String(filter.operator)}`); + } + const conditions: string[] = []; + const params: SqlValue[] = []; + for (const [key, value] of Object.entries(filter)) { + if (key === 'text') { + const text = textCondition(String(value), rank); + conditions.push(text.sql); + params.push(...text.params); + } else if (key === 'inAddressBook') { + conditions.push('EXISTS (SELECT 1 FROM contact_card_book b WHERE b.card_rowid = c.rowid AND b.book_id = ?)'); + params.push(String(value)); + } else { + throw new MethodError('unsupportedFilter', `${key} isn't available offline`); + } + } + return { sql: conditions.length ? conditions.join(' AND ') : '1', params }; +} + +const addressBookGet: MethodHandler = (ctx, args) => { + const jmap = jmapOf(ctx, args); + const state = syncedState(ctx, jmap, 'AddressBook'); + const books = listObjects>(ctx.db, jmap, 'AddressBook'); + const ids = Array.isArray(args.ids) ? args.ids as string[] : null; + const chosen = ids ? books.filter((book) => ids.includes(book.id as string)) : books; + return { + accountId: jmap, + ...(state ? { state } : {}), + list: chosen.map((book) => pick(book, args.properties)), + notFound: ids ? ids.filter((id) => !books.some((book) => book.id === id)) : [], + }; +}; + +const contactQuery: MethodHandler = (ctx, args) => { + const jmap = jmapOf(ctx, args); + syncedState(ctx, jmap, 'ContactCard'); + if (args.anchor !== undefined) throw new MethodError('unsupportedFilter', 'anchor needs the server'); + if (Array.isArray(args.sort) && args.sort.length > 0) throw new MethodError('unsupportedSort', 'Sorted lists need the server'); + const rank: string[] = []; + const where = args.filter ? filterSql(args.filter as Filter, rank) : { sql: '1', params: [] }; + const position = Math.max(0, Number(args.position ?? 0)); + // limit 0 means no limit on Stalwart, and the client can't tell a local answer apart. + const limit = typeof args.limit === 'number' && args.limit > 0 ? args.limit : -1; + // Names starting with what was typed come before ones merely containing it. + const first = rank.length > 0 ? 'c.rowid IN (SELECT rowid FROM contact_fts_word WHERE contact_fts_word MATCH ?) DESC, ' : ''; + const ids = ctx.db.all<{ id: string }>( + `SELECT c.id FROM contact_card c WHERE c.jmap = ? AND (${where.sql}) ORDER BY ${first}c.sort_key, c.id LIMIT ? OFFSET ?`, + [jmap, ...where.params, ...(rank.length > 0 ? [rank.join(' AND ')] : []), limit, position], + ).map((row) => String(row.id)); + const result: MethodResult = { + accountId: jmap, + // Local answers aren't a position in the server's log, so this is a token only. + queryState: 'local', + canCalculateChanges: false, + position, + ids, + }; + if (args.calculateTotal) { + result.total = Number(ctx.db.get<{ n: number }>( + `SELECT COUNT(*) AS n FROM contact_card c WHERE c.jmap = ? AND (${where.sql})`, + [jmap, ...where.params], + )?.n ?? 0); + } + return result; +}; + +const contactGet: MethodHandler = (ctx, args) => { + const jmap = jmapOf(ctx, args); + const state = syncedState(ctx, jmap, 'ContactCard'); + const list: Array> = []; + const notFound: string[] = []; + const rows = Array.isArray(args.ids) + ? (args.ids as string[]).map((id) => ({ id, row: ctx.db.get<{ json: string }>('SELECT json FROM contact_card WHERE jmap = ? AND id = ?', [jmap, resolveCardId(ctx.db, jmap, id)]) })) + : ctx.db.all<{ json: string; id: string }>('SELECT json, id FROM contact_card WHERE jmap = ? ORDER BY sort_key, id', [jmap]).map((row) => ({ id: row.id, row })); + for (const { id, row } of rows) { + if (row) list.push(pick(JSON.parse(row.json) as Record, args.properties)); + else notFound.push(id); + } + return { accountId: jmap, ...(state ? { state } : {}), list, notFound }; +}; + +/** + * Queues the edits. The answer leaves out oldState and newState: nothing + * reached the server, so there's no real state to name, and the client reads + * neither from ContactCard/set. + */ +const contactSet: MethodHandler = (ctx, args) => { + const jmap = jmapOf(ctx, args); + syncedState(ctx, jmap, 'ContactCard'); + const created: Record = {}; + const notCreated: Record = {}; + const updated: Record = {}; + const notUpdated: Record = {}; + const destroyed: string[] = []; + const notDestroyed: Record = {}; + ctx.db.transaction(() => { + for (const [cid, card] of Object.entries((args.create ?? {}) as Record)) { + const outcome = queueCreate(ctx, jmap, card); + if ('id' in outcome) created[cid] = outcome; + else notCreated[cid] = outcome; + } + for (const [id, patch] of Object.entries((args.update ?? {}) as Record)) { + const refused = queueUpdate(ctx, jmap, id, patch); + if (refused) notUpdated[id] = refused; + else updated[id] = null; + } + for (const id of (args.destroy ?? []) as string[]) { + const refused = queueDestroy(ctx, jmap, id); + if (refused) notDestroyed[id] = refused; + else destroyed.push(id); + } + }); + if (Object.keys(created).length + Object.keys(updated).length + destroyed.length > 0) { + ctx.emit({ type: 'changed', account: ctx.account, collections: ['ContactCard'] }); + } + const some = (name: string, value: object) => (Object.keys(value).length > 0 ? { [name]: value } : {}); + return { + accountId: jmap, + ...some('created', created), + ...some('notCreated', notCreated), + ...some('updated', updated), + ...some('notUpdated', notUpdated), + ...some('destroyed', destroyed), + ...some('notDestroyed', notDestroyed), + }; +}; + +export const CONTACT_METHODS: Readonly> = { + 'AddressBook/get': addressBookGet, + 'ContactCard/query': contactQuery, + 'ContactCard/get': contactGet, + 'ContactCard/set': contactSet, +}; diff --git a/lib/store/contacts/patch.ts b/lib/store/contacts/patch.ts new file mode 100644 index 000000000..07247b3d9 --- /dev/null +++ b/lib/store/contacts/patch.ts @@ -0,0 +1,88 @@ +/** + * RFC 8620 §5.3 patches: keys are JSON pointers without the leading slash, a + * null value removes the property. Written so the common outbox can use the + * same rules for its per-record merge. + */ + +export type JsonObject = Record; +export type Patch = Record; + +export class InvalidPatchError extends Error { + constructor(path: string) { + super(`Can't apply a patch at ${path}`); + this.name = 'InvalidPatchError'; + } +} + +function steps(path: string): string[] { + return path.split('/').map((step) => step.replace(/~1/g, '/').replace(/~0/g, '~')); +} + +function isObject(value: unknown): value is JsonObject { + return typeof value === 'object' && value !== null && !Array.isArray(value); +} + +/** A copy of the object with the patch applied. Throws when a path leads nowhere. */ +export function applyPatch(object: T, patch: Patch): T { + const root: JsonObject = { ...object }; + for (const [path, value] of Object.entries(patch)) { + const parts = steps(path); + let node = root; + for (const step of parts.slice(0, -1)) { + const next = node[step]; + if (!isObject(next)) throw new InvalidPatchError(path); + const copy = { ...next }; + node[step] = copy; + node = copy; + } + const last = parts[parts.length - 1]; + if (value === null) delete node[last]; + else node[last] = value; + } + return root as T; +} + +/** One patch that does what the older one and then the newer one would do. */ +export function mergePatches(older: Patch, newer: Patch): Patch { + const merged: Patch = { ...older }; + for (const [path, value] of Object.entries(newer)) { + // A newer write to a whole property replaces older writes below it. + for (const key of Object.keys(merged)) { + if (key.startsWith(`${path}/`)) delete merged[key]; + } + // A newer write below an older whole-property write goes into that value. + const parent = Object.keys(merged).find((key) => path.startsWith(`${key}/`)); + if (parent && isObject(merged[parent])) { + const holder = applyPatch({ value: merged[parent] }, { [`value/${path.slice(parent.length + 1)}`]: value }); + merged[parent] = holder.value; + } else { + merged[path] = value; + } + } + return merged; +} + +/** The top-level properties a patch writes to. */ +export function touchedProperties(patch: Patch): string[] { + return [...new Set(Object.keys(patch).map((path) => steps(path)[0]))]; +} + +/** Deep equality that ignores key order. Absent and null count as the same. */ +export function sameJson(a: unknown, b: unknown): boolean { + if (a === b || (a == null && b == null)) return true; + if (Array.isArray(a) && Array.isArray(b)) { + return a.length === b.length && a.every((item, i) => sameJson(item, b[i])); + } + if (isObject(a) && isObject(b)) { + return [...new Set([...Object.keys(a), ...Object.keys(b)])].every((key) => sameJson(a[key], b[key])); + } + return false; +} + +/** Whether `actual` holds everything in `wanted`. A server may add properties of its own. */ +export function coversJson(wanted: unknown, actual: unknown): boolean { + if (isObject(wanted) && isObject(actual)) { + return Object.keys(wanted).every((key) => coversJson(wanted[key], actual[key])); + } + return sameJson(wanted, actual); +} diff --git a/lib/store/contacts/pending.ts b/lib/store/contacts/pending.ts new file mode 100644 index 000000000..aaadc64b7 --- /dev/null +++ b/lib/store/contacts/pending.ts @@ -0,0 +1,459 @@ +/** + * Contact edits made while the server can't be reached, and sending them. + * + * One row per card, whatever number of edits it had. The visible card in + * contact_card already has the edits on top, and sync keeps it so. Sending + * runs at the start of each sync pass, so it never overlaps with itself. + * + * What a row becomes on its way out: + * - Update: the server's card is read first. Nothing to do if it already has + * the values (a lost response). A conflict if the server changed one of the + * properties the edit touches. Otherwise the patch goes out. + * - Destroy: done if the card is gone, a conflict if it changed since. + * - Create: a request that may have reached the server looks for the card's + * uid first, so a lost response doesn't make a second card. Stalwart also + * refuses a second card with the same uid, which ends up the same way. + */ + +import type { StoreContext, SyncContext } from '../area'; +import { responseFor, type MethodCall } from '../engine/transport'; +import type { StorageAdapter } from '../storage'; +import { applyPatch, coversJson, InvalidPatchError, mergePatches, sameJson, touchedProperties, type JsonObject, type Patch } from './patch'; +import { cardDisplayName, CONTACTS_USING, readCard, removeCard, writeCard, type Card } from './records'; + +export const STAND_IN_PREFIX = 'bulwark-local-card-'; +/** What a held upload's stand-in blob id starts with (lib/offline/queue.ts). */ +const LOCAL_BLOB_MARK = '"blobId":"bulwark-local-'; + +const SET_BATCH = 100; +const SET_BATCH_BYTES = 5 * 1024 * 1024; +const GET_BATCH = 500; +const CALLS_PER_REQUEST = 16; +/** Set errors that say nothing about the edit itself: it goes out again next time. */ +const TRANSIENT_ERRORS = new Set(['serverFail', 'serverUnavailable', 'rateLimit']); +/** Server-kept timestamps: their changing doesn't mean someone edited the card. */ +const SERVER_STAMPS = ['updated', 'created']; + +export interface PendingRow { + seq: number; + jmap: string; + id: string; + op: 'create' | 'update' | 'destroy'; + uid: string | null; + payload: string | null; + base: string | null; + attempted: number; + queued_at: number; +} + +export interface SetError { type: string; description?: string; properties?: string[] } + +export interface ContactConflict { + id: number; + jmap: string; + recordId: string; + kind: 'refused' | 'changed' | 'gone'; + summary: string; + local: { op: string; payload: unknown }; + server: unknown; + error: string | null; + createdAt: number; +} + +export function pendingFor(db: StorageAdapter, jmap: string, id: string): PendingRow | undefined { + return db.get('SELECT * FROM contact_pending WHERE jmap = ? AND id = ?', [jmap, id]); +} + +function dropPending(db: StorageAdapter, jmap: string, id: string): void { + db.run('DELETE FROM contact_pending WHERE jmap = ? AND id = ?', [jmap, id]); +} + +function savePending(db: StorageAdapter, ctx: { now(): number }, row: { jmap: string; id: string; op: PendingRow['op']; uid?: string | null; payload: string | null; base: string | null }): void { + db.run( + `INSERT INTO contact_pending (jmap, id, op, uid, payload, base, queued_at) VALUES (?, ?, ?, ?, ?, ?, ?) + ON CONFLICT (jmap, id) DO UPDATE SET op = excluded.op, uid = excluded.uid, payload = excluded.payload, base = excluded.base`, + [row.jmap, row.id, row.op, row.uid ?? null, row.payload, row.base, ctx.now()], + ); +} + +/** A stand-in id that already went through becomes the real one. */ +export function resolveCardId(db: StorageAdapter, jmap: string, id: string): string { + return db.get<{ real_id: string }>('SELECT real_id FROM contact_id_map WHERE jmap = ? AND local_id = ?', [jmap, id])?.real_id ?? id; +} + +/** A held upload can't be named in a card that goes out later. The client falls back to a data: URI. */ +function holdsLocalBlob(value: unknown): boolean { + return JSON.stringify(value).includes(LOCAL_BLOB_MARK); +} + +const LOCAL_BLOB_ERROR: SetError = { + type: 'invalidProperties', + description: 'A photo that is not on the server yet cannot be used here', + properties: ['media'], +}; + +export function queueCreate(ctx: StoreContext, jmap: string, card: JsonObject): { id: string; uid: string } | SetError { + if (holdsLocalBlob(card)) return LOCAL_BLOB_ERROR; + if (Object.keys((card.addressBookIds ?? {}) as object).length === 0) { + // The client picks the default book. None known means there's nowhere to put it. + return { type: 'invalidProperties', description: 'A contact needs an address book', properties: ['addressBookIds'] }; + } + const id = `${STAND_IN_PREFIX}${crypto.randomUUID()}`; + const uid = typeof card.uid === 'string' && card.uid ? card.uid : `urn:uuid:${crypto.randomUUID()}`; + const payload = { ...card, uid }; + savePending(ctx.db, ctx, { jmap, id, op: 'create', uid, payload: JSON.stringify(payload), base: null }); + writeCard(ctx.db, jmap, { '@type': 'Card', version: '1.0', ...payload, id }); + return { id, uid }; +} + +export function queueUpdate(ctx: StoreContext, jmap: string, rawId: string, patch: Patch): SetError | null { + const id = resolveCardId(ctx.db, jmap, rawId); + const card = readCard(ctx.db, jmap, id); + if (!card) return { type: 'notFound' }; + if ('id' in patch) return { type: 'invalidProperties', description: 'The id property is immutable.', properties: ['id'] }; + if (holdsLocalBlob(patch)) return LOCAL_BLOB_ERROR; + const pending = pendingFor(ctx.db, jmap, id); + let visible: Card; + try { + visible = applyPatch(card, patch); + } catch (error) { + if (error instanceof InvalidPatchError) return { type: 'invalidPatch', description: error.message }; + throw error; + } + if (pending?.op === 'create') { + const payload = applyPatch(JSON.parse(pending.payload as string) as JsonObject, patch); + savePending(ctx.db, ctx, { jmap, id, op: 'create', uid: pending.uid, payload: JSON.stringify(payload), base: null }); + } else { + const merged = pending ? mergePatches(JSON.parse(pending.payload as string) as Patch, patch) : patch; + savePending(ctx.db, ctx, { jmap, id, op: 'update', payload: JSON.stringify(merged), base: pending ? pending.base : JSON.stringify(card) }); + } + writeCard(ctx.db, jmap, visible); + return null; +} + +export function queueDestroy(ctx: StoreContext, jmap: string, rawId: string): SetError | null { + const id = resolveCardId(ctx.db, jmap, rawId); + const card = readCard(ctx.db, jmap, id); + if (!card) return { type: 'notFound' }; + const pending = pendingFor(ctx.db, jmap, id); + if (pending?.op === 'create' && !pending.attempted) { + // Never reached the server, so it never has to. + dropPending(ctx.db, jmap, id); + } else if (pending?.op === 'create') { + // It may have reached the server. Sending decides, then destroys it. + savePending(ctx.db, ctx, { jmap, id, op: 'destroy', uid: pending.uid, payload: pending.payload, base: null }); + } else { + savePending(ctx.db, ctx, { jmap, id, op: 'destroy', payload: null, base: pending ? pending.base : JSON.stringify(card) }); + } + removeCard(ctx.db, jmap, id); + return null; +} + +// ---- What sync does around queued edits ---- + +/** Stores a card the server sent, with whatever is queued for it on top. */ +export function storeServerCard(db: StorageAdapter, jmap: string, card: Card, gen?: number): void { + const pending = pendingFor(db, jmap, card.id); + if (pending?.op === 'destroy') return; + let visible = card; + if (pending?.op === 'update') { + try { + visible = applyPatch(card, JSON.parse(pending.payload as string) as Patch); + } catch (error) { + // The patch no longer fits the card. Sending turns this into a conflict. + if (!(error instanceof InvalidPatchError)) throw error; + } + } + writeCard(db, jmap, visible, gen); +} + +/** The server no longer has this card. */ +export function serverDestroyed(ctx: StoreContext, jmap: string, id: string): void { + const pending = pendingFor(ctx.db, jmap, id); + if (pending?.op === 'update') recordConflict(ctx, pending, 'gone', null, null); + if (pending && pending.op !== 'create') dropPending(ctx.db, jmap, id); + removeCard(ctx.db, jmap, id); +} + +function recordConflict(ctx: StoreContext, row: PendingRow, kind: ContactConflict['kind'], server: Card | null, error: SetError | null): void { + const local = row.payload ? JSON.parse(row.payload) as JsonObject : null; + const known = server ?? readCard(ctx.db, row.jmap, row.id) ?? (row.base ? JSON.parse(row.base) as JsonObject : local); + ctx.db.run( + 'INSERT INTO contact_conflict (jmap, record_id, kind, summary, local, server, error, created_at) VALUES (?, ?, ?, ?, ?, ?, ?, ?)', + [ + row.jmap, + row.id, + kind, + cardDisplayName(known ?? {}), + JSON.stringify({ op: row.op, payload: local }), + server ? JSON.stringify(server) : null, + error ? [error.type, error.description].filter(Boolean).join(': ') : null, + ctx.now(), + ], + ); +} + +export function listConflicts(db: StorageAdapter): ContactConflict[] { + return db.all<{ id: number; jmap: string; record_id: string; kind: ContactConflict['kind']; summary: string; local: string; server: string | null; error: string | null; created_at: number }>( + 'SELECT * FROM contact_conflict ORDER BY id', + ).map((row) => ({ + id: Number(row.id), + jmap: row.jmap, + recordId: row.record_id, + kind: row.kind, + summary: row.summary, + local: JSON.parse(row.local) as ContactConflict['local'], + server: row.server ? JSON.parse(row.server) : null, + error: row.error, + createdAt: Number(row.created_at), + })); +} + +export function pendingCount(db: StorageAdapter): number { + return Number(db.get<{ n: number }>('SELECT COUNT(*) AS n FROM contact_pending')?.n ?? 0); +} + +// ---- Sending ---- + +function withoutStamps(card: JsonObject): JsonObject { + const copy = { ...card }; + for (const key of SERVER_STAMPS) delete copy[key]; + return copy; +} + +async function readServerCards(ctx: SyncContext, jmap: string, ids: string[]): Promise> { + const cards = new Map(); + for (let i = 0; i < ids.length; i += GET_BATCH) { + const response = await ctx.transport.request([['ContactCard/get', { accountId: jmap, ids: ids.slice(i, i + GET_BATCH) }, 'g']], CONTACTS_USING); + for (const card of responseFor(response, 'g')[1].list as Card[]) cards.set(card.id, card); + } + return cards; +} + +/** The ids the server has for these uids. */ +async function lookUpUids(ctx: SyncContext, jmap: string, uids: string[]): Promise> { + const found = new Map(); + for (let i = 0; i < uids.length; i += CALLS_PER_REQUEST) { + const group = uids.slice(i, i + CALLS_PER_REQUEST); + const calls: MethodCall[] = group.map((uid, n) => ['ContactCard/query', { accountId: jmap, filter: { uid }, limit: 1 }, `q${n}`]); + const response = await ctx.transport.request(calls, CONTACTS_USING); + group.forEach((uid, n) => { + const ids = responseFor(response, `q${n}`)[1].ids as string[]; + if (ids.length > 0) found.set(uid, ids[0]); + }); + } + return found; +} + +/** The create went through, or had already. The stand-in row becomes the server's card. */ +function settleCreated(ctx: SyncContext, sent: PendingRow, server: Card): void { + const { db } = ctx; + const { jmap, id: standIn } = sent; + const now = pendingFor(db, jmap, standIn); + db.run('INSERT OR REPLACE INTO contact_id_map (jmap, local_id, real_id) VALUES (?, ?, ?)', [jmap, standIn, server.id]); + dropPending(db, jmap, standIn); + removeCard(db, jmap, standIn); + if (now?.op === 'destroy' || !now) { + // Deleted while the create was on its way: delete the real one next. + savePending(db, ctx, { jmap, id: server.id, op: 'destroy', payload: null, base: JSON.stringify(server) }); + return; + } + if (now.payload !== sent.payload) { + // Edited while the create was on its way: what differs goes out as an edit. + const before = JSON.parse(sent.payload as string) as JsonObject; + const after = JSON.parse(now.payload as string) as JsonObject; + const patch: Patch = {}; + for (const key of new Set([...Object.keys(before), ...Object.keys(after)])) { + if (!sameJson(before[key], after[key])) patch[key.replace(/~/g, '~0').replace(/\//g, '~1')] = after[key] ?? null; + } + savePending(db, ctx, { jmap, id: server.id, op: 'update', payload: JSON.stringify(patch), base: JSON.stringify(server) }); + writeCard(db, jmap, applyPatch(server, patch)); + return; + } + writeCard(db, jmap, server); +} + +interface Decision { create: Map; update: Map; destroy: Map } + +/** What to do with one row now that the server's copy is known. Conflicts are settled here. */ +function decide(ctx: SyncContext, row: PendingRow, server: Card | undefined, serverByUid: Map, out: Decision): void { + const { db } = ctx; + const { jmap, id } = row; + const uidHit = row.uid ? serverByUid.get(row.uid) : undefined; + if (row.op === 'create') { + if (uidHit) { + settleCreated(ctx, row, { ...(JSON.parse(row.payload as string) as JsonObject), ...uidHit }); + return; + } + out.create.set(id, row); + return; + } + if (row.op === 'destroy' && id.startsWith(STAND_IN_PREFIX)) { + // A create that may have gone out, deleted since. Without a card on the server, nothing to do. + dropPending(db, jmap, id); + if (uidHit) savePending(db, ctx, { jmap, id: uidHit.id, op: 'destroy', payload: null, base: JSON.stringify(uidHit) }); + return; + } + if (row.op === 'destroy') { + if (!server) { + dropPending(db, jmap, id); + } else if (row.base && !sameJson(withoutStamps(JSON.parse(row.base) as JsonObject), withoutStamps(server))) { + recordConflict(ctx, row, 'changed', server, null); + dropPending(db, jmap, id); + writeCard(db, jmap, server); + } else { + out.destroy.set(id, row); + } + return; + } + if (!server) { + recordConflict(ctx, row, 'gone', null, null); + dropPending(db, jmap, id); + removeCard(db, jmap, id); + return; + } + const patch = JSON.parse(row.payload as string) as Patch; + const base = row.base ? JSON.parse(row.base) as JsonObject : null; + let applied: Card | null = null; + try { + applied = applyPatch(server, patch); + } catch (error) { + if (!(error instanceof InvalidPatchError)) throw error; + } + const touched = touchedProperties(patch); + if (applied && touched.every((key) => coversJson((applied as Card)[key], server[key]))) { + dropPending(db, jmap, id); + writeCard(db, jmap, server); + return; + } + if (!applied || (base && touched.some((key) => !sameJson(base[key], server[key])))) { + recordConflict(ctx, row, 'changed', server, null); + dropPending(db, jmap, id); + writeCard(db, jmap, server); + return; + } + out.update.set(id, row); +} + +function settleUpdated(ctx: SyncContext, sent: PendingRow, server: Card): void { + const now = pendingFor(ctx.db, sent.jmap, sent.id); + if (!now) return; + if (now.op === 'update' && now.payload === sent.payload) { + dropPending(ctx.db, sent.jmap, sent.id); + return; + } + // Edited again while this was on its way: that edit now builds on what was sent. + const base = applyPatch(server, JSON.parse(sent.payload as string) as Patch); + ctx.db.run('UPDATE contact_pending SET base = ? WHERE seq = ?', [JSON.stringify(base), now.seq]); +} + +function settleRefused(ctx: SyncContext, row: PendingRow, error: SetError, server: Card | undefined): void { + const { db } = ctx; + if (TRANSIENT_ERRORS.has(error.type)) return; + if (row.op === 'destroy' && error.type === 'notFound') { + dropPending(db, row.jmap, row.id); + return; + } + const kind = error.type === 'notFound' ? 'gone' : 'refused'; + recordConflict(ctx, row, kind, server ?? null, error); + dropPending(db, row.jmap, row.id); + if (server && kind === 'refused') writeCard(db, row.jmap, server); + else removeCard(db, row.jmap, row.id); +} + +/** Takes rows up to about the size of one request. */ +function nextBatch(db: StorageAdapter, jmap: string, afterSeq: number): PendingRow[] { + const rows = db.all('SELECT * FROM contact_pending WHERE jmap = ? AND seq > ? ORDER BY seq LIMIT ?', [jmap, afterSeq, SET_BATCH]); + let bytes = 0; + const batch: PendingRow[] = []; + for (const row of rows) { + bytes += row.payload?.length ?? 0; + if (batch.length > 0 && bytes > SET_BATCH_BYTES) break; + batch.push(row); + } + return batch; +} + +/** Sends what's queued for one JMAP account. Network failures reach the engine and the rows stay. */ +export async function flushPending(ctx: SyncContext, jmap: string): Promise { + const { db } = ctx; + let afterSeq = 0; + let settled = false; + for (;;) { + if (ctx.stopped()) break; + const batch = nextBatch(db, jmap, afterSeq); + if (batch.length === 0) break; + afterSeq = batch[batch.length - 1].seq; + settled = true; + + const current = await readServerCards(ctx, jmap, batch.filter((row) => row.op !== 'create' && !row.id.startsWith(STAND_IN_PREFIX)).map((row) => row.id)); + const attempted = batch.filter((row) => row.uid && row.attempted).map((row) => row.uid as string); + const uidIds = await lookUpUids(ctx, jmap, attempted); + const uidCards = await readServerCards(ctx, jmap, [...uidIds.values()]); + const serverByUid = new Map(); + for (const [uid, id] of uidIds) { + const card = uidCards.get(id); + if (card) serverByUid.set(uid, card); + } + + const out: Decision = { create: new Map(), update: new Map(), destroy: new Map() }; + db.transaction(() => { + for (const { seq, id } of batch) { + // The page may have edited it while the reads were on their way. + const row = pendingFor(db, jmap, id); + if (row && row.seq === seq) decide(ctx, row, current.get(id), serverByUid, out); + } + for (const row of out.create.values()) db.run('UPDATE contact_pending SET attempted = 1 WHERE seq = ?', [row.seq]); + }); + if (out.create.size + out.update.size + out.destroy.size === 0) continue; + + const creationIds = new Map([...out.create.values()].map((row) => [`c${row.seq}`, row])); + const response = await ctx.transport.request([['ContactCard/set', { + accountId: jmap, + ...(creationIds.size > 0 ? { create: Object.fromEntries([...creationIds].map(([cid, row]) => [cid, JSON.parse(row.payload as string)])) } : {}), + ...(out.update.size > 0 ? { update: Object.fromEntries([...out.update.values()].map((row) => [row.id, JSON.parse(row.payload as string)])) } : {}), + ...(out.destroy.size > 0 ? { destroy: [...out.destroy.keys()] } : {}), + }, 's']], CONTACTS_USING); + const [, result] = responseFor(response, 's'); + + const refusedUid: Array<[PendingRow, SetError]> = []; + db.transaction(() => { + for (const [cid, row] of creationIds) { + const created = result.created?.[cid] as JsonObject | undefined; + const refused = result.notCreated?.[cid] as SetError | undefined; + if (created) { + settleCreated(ctx, row, { ...(JSON.parse(row.payload as string) as JsonObject), ...created, id: String(created.id) }); + } else if (refused?.properties?.includes('uid')) { + refusedUid.push([row, refused]); + } else if (refused) { + settleRefused(ctx, row, refused, undefined); + } + } + for (const [id, row] of out.update) { + const refused = result.notUpdated?.[id] as SetError | undefined; + if (refused) settleRefused(ctx, row, refused, current.get(id)); + else if (result.updated && id in result.updated) settleUpdated(ctx, row, current.get(id) as Card); + } + for (const [id, row] of out.destroy) { + const refused = result.notDestroyed?.[id] as SetError | undefined; + if (refused) settleRefused(ctx, row, refused, current.get(id)); + else if ((result.destroyed as string[] | undefined)?.includes(id)) dropPending(db, jmap, id); + } + }); + + // The server has a card with this uid already: this one, sent before. + if (refusedUid.length > 0) { + const ids = await lookUpUids(ctx, jmap, refusedUid.map(([row]) => row.uid as string)); + const cards = await readServerCards(ctx, jmap, [...ids.values()]); + db.transaction(() => { + for (const [row, refused] of refusedUid) { + const id = ids.get(row.uid as string); + const card = id ? cards.get(id) : undefined; + if (card) settleCreated(ctx, row, { ...(JSON.parse(row.payload as string) as JsonObject), ...card }); + else settleRefused(ctx, row, refused, undefined); + } + }); + } + } + if (settled) ctx.emit({ type: 'changed', account: ctx.account, collections: ['ContactCard'] }); +} diff --git a/lib/store/contacts/records.ts b/lib/store/contacts/records.ts new file mode 100644 index 000000000..07dc2f73b --- /dev/null +++ b/lib/store/contacts/records.ts @@ -0,0 +1,116 @@ +/** How a ContactCard becomes rows, and how the search index reads it. */ + +import type { SqlValue, StorageAdapter } from '../storage'; + +export const CONTACTS_CAPABILITY = 'urn:ietf:params:jmap:contacts'; +export const CONTACTS_USING = ['urn:ietf:params:jmap:core', CONTACTS_CAPABILITY]; + +/** As the client asks for them. Without them Stalwart may leave out shareWith and myRights. */ +export const ADDRESS_BOOK_PROPERTIES = ['id', 'name', 'description', 'sortOrder', 'isDefault', 'isSubscribed', 'shareWith', 'myRights']; + +export type Card = Record & { id: string }; + +function values(map: unknown): Array> { + if (typeof map !== 'object' || map === null) return []; + return Object.values(map).filter((v): v is Record => typeof v === 'object' && v !== null); +} + +function strings(items: unknown[]): string[] { + return items.filter((item): item is string => typeof item === 'string' && item.length > 0); +} + +/** Lower case, no accents: what both the index and the search terms go through. */ +export function foldText(text: string): string { + return text + .normalize('NFKD') + .replace(/\p{M}+/gu, '') + .toLowerCase() + .replace(/ß/g, 'ss') + .replace(/æ/g, 'ae') + .replace(/œ/g, 'oe') + .replace(/[øđł]/g, (c) => ({ ø: 'o', đ: 'd', ł: 'l' })[c] as string); +} + +/** + * The text to index. A German name is indexed both ways, since people type + * "Mueller" for "Müller" as often as "Muller". + */ +function indexText(text: string): string { + const folded = foldText(text); + const german = foldText( + text.normalize('NFC').replace(/[äÄ]/g, 'ae').replace(/[öÖ]/g, 'oe').replace(/[üÜ]/g, 'ue'), + ); + return german === folded ? folded : `${folded} ${german}`; +} + +export function cardDisplayName(card: Record): string { + const name = card.name as { full?: unknown; components?: unknown } | undefined; + if (typeof name?.full === 'string' && name.full) return name.full; + const parts = Array.isArray(name?.components) ? strings((name.components as Array<{ value?: unknown }>).map((c) => c?.value)) : []; + if (parts.length > 0) return parts.join(' '); + return strings(values(card.emails).map((e) => e.address))[0] ?? ''; +} + +function cardIndex(card: Record): { name: string; email: string; org: string } { + const name = card.name as { full?: unknown; components?: unknown } | undefined; + const components = Array.isArray(name?.components) ? (name.components as Array<{ value?: unknown }>).map((c) => c?.value) : []; + const nicknames = values(card.nicknames).map((n) => n.name); + const emails = values(card.emails).map((e) => e.address); + const organizations = values(card.organizations).flatMap((o) => [ + o.name, + ...(Array.isArray(o.units) ? (o.units as Array<{ name?: unknown }>).map((u) => u?.name) : []), + ]); + return { + name: indexText(strings([name?.full, ...components, ...nicknames]).join(' ')), + email: indexText(strings(emails).join(' ')), + org: indexText(strings(organizations).join(' ')), + }; +} + +function books(card: Record): string[] { + const ids = card.addressBookIds; + if (typeof ids !== 'object' || ids === null) return []; + return Object.entries(ids).filter(([, on]) => on).map(([id]) => id); +} + +/** Writes one card and its index rows. Without a gen, the row keeps its own. */ +export function writeCard(db: StorageAdapter, jmap: string, card: Card, gen?: number): void { + const existing = db.get<{ rowid: number; gen: number }>('SELECT rowid, gen FROM contact_card WHERE jmap = ? AND id = ?', [jmap, card.id]); + const row: SqlValue[] = [ + typeof card.uid === 'string' ? card.uid : null, + foldText(cardDisplayName(card)), + JSON.stringify(card), + gen ?? Number(existing?.gen ?? 0), + ]; + let rowid: number; + if (existing) { + rowid = Number(existing.rowid); + db.run('UPDATE contact_card SET uid = ?, sort_key = ?, json = ?, gen = ? WHERE rowid = ?', [...row, rowid]); + dropIndex(db, rowid); + } else { + rowid = db.run('INSERT INTO contact_card (uid, sort_key, json, gen, jmap, id) VALUES (?, ?, ?, ?, ?, ?)', [...row, jmap, card.id]).lastInsertRowid; + } + const text = cardIndex(card); + for (const table of ['contact_fts_word', 'contact_fts_tri']) { + db.run(`INSERT INTO ${table} (rowid, name, email, org) VALUES (?, ?, ?, ?)`, [rowid, text.name, text.email, text.org]); + } + for (const book of books(card)) db.run('INSERT OR IGNORE INTO contact_card_book (card_rowid, book_id) VALUES (?, ?)', [rowid, book]); +} + +function dropIndex(db: StorageAdapter, rowid: number): void { + db.run('DELETE FROM contact_fts_word WHERE rowid = ?', [rowid]); + db.run('DELETE FROM contact_fts_tri WHERE rowid = ?', [rowid]); + db.run('DELETE FROM contact_card_book WHERE card_rowid = ?', [rowid]); +} + +export function removeCard(db: StorageAdapter, jmap: string, id: string): void { + const existing = db.get<{ rowid: number }>('SELECT rowid FROM contact_card WHERE jmap = ? AND id = ?', [jmap, id]); + if (!existing) return; + dropIndex(db, Number(existing.rowid)); + db.run('DELETE FROM contact_card WHERE rowid = ?', [existing.rowid]); +} + +export function readCard(db: StorageAdapter, jmap: string, id: string): Card | null { + const row = db.get<{ json: string }>('SELECT json FROM contact_card WHERE jmap = ? AND id = ?', [jmap, id]); + return row ? JSON.parse(row.json) as Card : null; +} diff --git a/lib/store/contacts/schema.ts b/lib/store/contacts/schema.ts new file mode 100644 index 000000000..66b30832c --- /dev/null +++ b/lib/store/contacts/schema.ts @@ -0,0 +1,75 @@ +import type { Migration } from '../storage'; + +export const CONTACT_MIGRATIONS: readonly Migration[] = [ + { + id: 600, + name: 'contacts', + sql: ` + CREATE TABLE contact_card ( + rowid INTEGER PRIMARY KEY, + jmap TEXT NOT NULL, + id TEXT NOT NULL, + uid TEXT, + sort_key TEXT NOT NULL DEFAULT '', + -- What the UI sees: the server's card with queued edits on top. + json TEXT NOT NULL, + gen INTEGER NOT NULL DEFAULT 0, + UNIQUE (jmap, id) + ); + CREATE INDEX contact_card_sort ON contact_card (jmap, sort_key, id); + CREATE TABLE contact_card_book ( + card_rowid INTEGER NOT NULL, + book_id TEXT NOT NULL, + PRIMARY KEY (card_rowid, book_id) + ) WITHOUT ROWID; + CREATE INDEX contact_card_book_lookup ON contact_card_book (book_id, card_rowid); + -- Text goes in through foldText (records.ts), which also takes care of accents. + CREATE VIRTUAL TABLE contact_fts_word USING fts5( + name, email, org, + content = '', contentless_delete = 1, + tokenize = 'unicode61 remove_diacritics 0', + prefix = '2 3' + ); + CREATE VIRTUAL TABLE contact_fts_tri USING fts5( + name, email, org, + content = '', contentless_delete = 1, + tokenize = 'trigram' + ); + -- One row per card with something to send. Edits to a card merge here. + CREATE TABLE contact_pending ( + seq INTEGER PRIMARY KEY AUTOINCREMENT, + jmap TEXT NOT NULL, + id TEXT NOT NULL, + op TEXT NOT NULL, + uid TEXT, + -- create: the whole card. update: the merged patch. destroy: nothing. + payload TEXT, + -- The server's card when the first edit was queued, to see what changed there since. + base TEXT, + -- A request may have reached the server, so a create looks for its uid first. + attempted INTEGER NOT NULL DEFAULT 0, + queued_at INTEGER NOT NULL, + UNIQUE (jmap, id) + ); + -- Stand-in ids the page may still hold after a create went through. + CREATE TABLE contact_id_map ( + jmap TEXT NOT NULL, + local_id TEXT NOT NULL, + real_id TEXT NOT NULL, + PRIMARY KEY (jmap, local_id) + ) WITHOUT ROWID; + CREATE TABLE contact_conflict ( + id INTEGER PRIMARY KEY AUTOINCREMENT, + jmap TEXT NOT NULL, + record_id TEXT NOT NULL, + -- refused: the server said no. changed: edited there too. gone: deleted there. + kind TEXT NOT NULL, + summary TEXT NOT NULL, + local TEXT NOT NULL, + server TEXT, + error TEXT, + created_at INTEGER NOT NULL + ); + `, + }, +]; diff --git a/lib/store/contacts/sync.ts b/lib/store/contacts/sync.ts new file mode 100644 index 000000000..f734263d6 --- /dev/null +++ b/lib/store/contacts/sync.ts @@ -0,0 +1,179 @@ +/** + * Contact sync for one JMAP account: first what's queued goes out, then the + * address books, then the cards. A full pass over the cards captures the + * state first and pages, with its cursor in sync_state, so a reload continues + * where it stopped. Cards the pass didn't see are gone from the server. + */ + +import type { SyncContext, Syncer } from '../area'; +import { runChangesLoop } from '../engine/changes'; +import { deleteObject, putObject } from '../engine/core-schema'; +import { responseFor, type MethodCall } from '../engine/transport'; +import { flushPending, serverDestroyed, storeServerCard } from './pending'; +import { ADDRESS_BOOK_PROPERTIES, CONTACTS_CAPABILITY, CONTACTS_USING, type Card } from './records'; + +const PAGE = 500; +const PAIRS_PER_REQUEST = 4; + +// ---- Address books ---- + +async function fullBooks(ctx: SyncContext, jmap: string): Promise { + const response = await ctx.transport.request([['AddressBook/get', { accountId: jmap, properties: ADDRESS_BOOK_PROPERTIES }, 'b']], CONTACTS_USING); + const [, result] = responseFor(response, 'b'); + ctx.db.transaction(() => { + ctx.db.run("DELETE FROM object WHERE jmap = ? AND type = 'AddressBook'", [jmap]); + for (const book of result.list as Array<{ id: string }>) putObject(ctx.db, jmap, 'AddressBook', book.id, book); + ctx.setSyncState(jmap, 'AddressBook', { state: String(result.state), phase: null, cursor: null }); + }); + ctx.emit({ type: 'changed', account: ctx.account, collections: ['AddressBook'] }); +} + +async function syncBooks(ctx: SyncContext, jmap: string): Promise { + const { state, target } = ctx.syncState(jmap, 'AddressBook'); + if (!state) return fullBooks(ctx, jmap); + const outcome = await runChangesLoop({ + transport: ctx.transport, + type: 'AddressBook', + jmap, + using: CONTACTS_USING, + since: state, + target, + stopped: ctx.stopped, + apply: async (page) => { + const ids = [...page.created, ...page.updated]; + const list: Array<{ id: string }> = []; + for (let i = 0; i < ids.length; i += PAGE) { + const response = await ctx.transport.request([['AddressBook/get', { accountId: jmap, ids: ids.slice(i, i + PAGE), properties: ADDRESS_BOOK_PROPERTIES }, 'b']], CONTACTS_USING); + list.push(...responseFor(response, 'b')[1].list); + } + ctx.db.transaction(() => { + for (const book of list) putObject(ctx.db, jmap, 'AddressBook', book.id, book); + for (const id of page.destroyed) deleteObject(ctx.db, jmap, 'AddressBook', id); + ctx.setSyncState(jmap, 'AddressBook', { state: page.newState }); + }); + if (ids.length + page.destroyed.length > 0) ctx.emit({ type: 'changed', account: ctx.account, collections: ['AddressBook'] }); + }, + }); + if (outcome.outcome === 'resync') await fullBooks(ctx, jmap); +} + +// ---- Cards ---- + +interface ListCursor { position: number; gen: number; captured: string } + +async function startFullList(ctx: SyncContext, jmap: string): Promise { + const response = await ctx.transport.request([['ContactCard/get', { accountId: jmap, ids: [] }, 's']], CONTACTS_USING); + const captured = String(responseFor(response, 's')[1].state); + const gen = Number(ctx.db.get<{ gen: number | null }>('SELECT MAX(gen) AS gen FROM contact_card WHERE jmap = ?', [jmap])?.gen ?? 0) + 1; + const cursor: ListCursor = { position: 0, gen, captured }; + ctx.db.transaction(() => ctx.setSyncState(jmap, 'ContactCard', { state: null, phase: 'list', cursor: { ...cursor } })); + return cursor; +} + +/** Cards from before this pass that it didn't find, leaving alone creates still on this device. */ +function sweep(ctx: SyncContext, jmap: string, gen: number): void { + const stale = ctx.db.all<{ id: string }>( + `SELECT c.id FROM contact_card c WHERE c.jmap = ? AND c.gen < ? + AND NOT EXISTS (SELECT 1 FROM contact_pending p WHERE p.jmap = c.jmap AND p.id = c.id AND p.op = 'create')`, + [jmap, gen], + ); + for (const row of stale) serverDestroyed(ctx, jmap, String(row.id)); +} + +async function runFullList(ctx: SyncContext, jmap: string, start: ListCursor): Promise { + const cursor = { ...start }; + for (;;) { + if (ctx.stopped()) return false; + const calls: MethodCall[] = []; + for (let i = 0; i < PAIRS_PER_REQUEST; i += 1) { + calls.push(['ContactCard/query', { accountId: jmap, position: cursor.position + i * PAGE, limit: PAGE, calculateTotal: i === 0 }, `q${i}`]); + calls.push(['ContactCard/get', { accountId: jmap, '#ids': { resultOf: `q${i}`, name: 'ContactCard/query', path: '/ids' } }, `g${i}`]); + } + const response = await ctx.transport.request(calls, CONTACTS_USING); + let total: number | null = null; + let got = 0; + let short = false; + const cards: Card[] = []; + for (let i = 0; i < PAIRS_PER_REQUEST && !short; i += 1) { + const [, query] = responseFor(response, `q${i}`); + if (i === 0 && typeof query.total === 'number') total = query.total; + cards.push(...responseFor(response, `g${i}`)[1].list as Card[]); + got += (query.ids as string[]).length; + short = (query.ids as string[]).length < PAGE; + } + cursor.position += got; + const done = got === 0 || (total === null ? short : cursor.position >= total); + ctx.db.transaction(() => { + for (const card of cards) storeServerCard(ctx.db, jmap, card, cursor.gen); + if (done) { + sweep(ctx, jmap, cursor.gen); + ctx.setSyncState(jmap, 'ContactCard', { state: cursor.captured, phase: null, cursor: null }); + } else { + ctx.setSyncState(jmap, 'ContactCard', { cursor: { ...cursor } }); + } + }); + ctx.emit({ type: 'progress', account: ctx.account, area: 'contacts', phase: 'list', done: cursor.position, total }); + if (done) { + ctx.emit({ type: 'changed', account: ctx.account, collections: ['ContactCard'] }); + return true; + } + } +} + +async function syncDelta(ctx: SyncContext, jmap: string, since: string, target: string | null): Promise<'done' | 'resync' | 'stopped'> { + const outcome = await runChangesLoop({ + transport: ctx.transport, + type: 'ContactCard', + jmap, + using: CONTACTS_USING, + since, + target, + stopped: ctx.stopped, + apply: async (page) => { + const ids = [...page.created, ...page.updated]; + const fetched: Card[] = []; + for (let i = 0; i < ids.length; i += PAGE) { + const response = await ctx.transport.request([['ContactCard/get', { accountId: jmap, ids: ids.slice(i, i + PAGE) }, 'g']], CONTACTS_USING); + fetched.push(...responseFor(response, 'g')[1].list as Card[]); + } + ctx.db.transaction(() => { + const gen = Number(ctx.db.get<{ gen: number | null }>('SELECT MAX(gen) AS gen FROM contact_card WHERE jmap = ?', [jmap])?.gen ?? 0); + for (const card of fetched) storeServerCard(ctx.db, jmap, card, gen); + for (const id of page.destroyed) serverDestroyed(ctx, jmap, id); + ctx.setSyncState(jmap, 'ContactCard', { state: page.newState }); + }); + if (ids.length + page.destroyed.length > 0) ctx.emit({ type: 'changed', account: ctx.account, collections: ['ContactCard'] }); + }, + }); + if (outcome.outcome === 'resync') return 'resync'; + return outcome.outcome === 'stopped' ? 'stopped' : 'done'; +} + +async function syncCards(ctx: SyncContext, jmap: string): Promise { + const row = ctx.syncState(jmap, 'ContactCard'); + let cursor = row.phase === 'list' ? row.cursor as unknown as ListCursor : null; + if (!cursor && !row.state) cursor = await startFullList(ctx, jmap); + if (!cursor && row.state) { + const outcome = await syncDelta(ctx, jmap, row.state, row.target); + if (outcome === 'stopped') return; + if (outcome === 'resync') cursor = await startFullList(ctx, jmap); + } + if (cursor) { + if (!(await runFullList(ctx, jmap, cursor))) return; + // Catch what changed while paging. + const after = ctx.syncState(jmap, 'ContactCard'); + if (after.state) await syncDelta(ctx, jmap, after.state, after.target); + } +} + +export const contactsSyncer: Syncer = { + name: 'contacts', + capability: CONTACTS_CAPABILITY, + async run(ctx, jmap) { + await flushPending(ctx, jmap); + if (ctx.stopped()) return; + await syncBooks(ctx, jmap); + if (ctx.stopped()) return; + await syncCards(ctx, jmap); + }, +}; diff --git a/lib/store/engine/account-engine.ts b/lib/store/engine/account-engine.ts index 6281afc71..a3d56298e 100644 --- a/lib/store/engine/account-engine.ts +++ b/lib/store/engine/account-engine.ts @@ -196,6 +196,7 @@ export class AccountEngine { transport: this.transport, now: this.now, emit: this.emitter, + requestSync: () => this.requestSync(), stopped: () => this.closed || !this.online, syncState: (jmap, type) => this.syncState(jmap, type), setSyncState: (jmap, type, row) => this.setSyncState(jmap, type, row), @@ -210,6 +211,7 @@ export class AccountEngine { scope: this.scope, now: this.now, emit: this.emitter, + requestSync: () => this.requestSync(), }; } From 7bb8447743db33c21b59d6cda97806a2a2930bbb Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 05:47:00 +0100 Subject: [PATCH 02/20] fix: keep the contact list when the address book can't be read --- lib/jmap/client.ts | 27 ++++- lib/store/__tests__/client-contacts.test.ts | 113 ++++++++++++++++++++ stores/__tests__/contact-store.test.ts | 34 +++++- stores/contact-store.ts | 5 +- 4 files changed, 172 insertions(+), 7 deletions(-) create mode 100644 lib/store/__tests__/client-contacts.test.ts diff --git a/lib/jmap/client.ts b/lib/jmap/client.ts index 6d35dcdfa..56258dd86 100644 --- a/lib/jmap/client.ts +++ b/lib/jmap/client.ts @@ -7327,7 +7327,10 @@ export class JMAPClient implements IJMAPClient { } } + /** Throws when no account could answer, so a failure doesn't read as having no address books. */ async getAllAddressBooks(): Promise { + let answered = 0; + let failure: unknown; try { const allBooks: AddressBook[] = []; const primaryId = this.getContactsAccountId(); @@ -7353,17 +7356,23 @@ export class JMAPClient implements IJMAPClient { isShared: !isPrimary, })); allBooks.push(...books); + answered += 1; + } else if (response.methodResponses?.[0]?.[0] === "error") { + const refused = response.methodResponses[0][1]; + throw new Error(refused?.description || refused?.type || "AddressBook/get failed"); } } catch (error) { console.error(`Failed to fetch address books for account ${accountId}:`, error); + failure ??= error; } } - return allBooks; + if (answered > 0 || !failure) return allBooks; } catch (error) { console.error('Failed to fetch all address books:', error); return this.getAddressBooks(); } + throw failure; } async createAddressBook(name: string): Promise { @@ -8230,6 +8239,8 @@ export class JMAPClient implements IJMAPClient { ], this.contactUsing()); const queryResult = response.methodResponses?.[0]; + // A refused call isn't an empty address book: the caller keeps what it has. + if (queryResult?.[0] === "error") throw new Error(queryResult[1]?.description || queryResult[1]?.type || "ContactCard/query failed"); if (queryResult?.[0] !== "ContactCard/query") break; const ids: string[] = queryResult[1].ids || []; @@ -8252,8 +8263,10 @@ export class JMAPClient implements IJMAPClient { ["ContactCard/get", { accountId, ids: chunk }, "g"], ], this.contactUsing()); - if (response.methodResponses?.[0]?.[0] === "ContactCard/get") { - const list = (response.methodResponses[0][1].list || []) as ContactCard[]; + const getResult = response.methodResponses?.[0]; + if (getResult?.[0] === "error") throw new Error(getResult[1]?.description || getResult[1]?.type || "ContactCard/get failed"); + if (getResult?.[0] === "ContactCard/get") { + const list = (getResult[1].list || []) as ContactCard[]; allContacts.push(...list.map(contactFromWire)); } } @@ -8273,7 +8286,10 @@ export class JMAPClient implements IJMAPClient { } } + /** Throws when no account could answer, so a failure doesn't read as an empty address book. */ async getAllContacts(): Promise { + let answered = 0; + let failure: unknown; try { const allContacts: ContactCard[] = []; const primaryId = this.getContactsAccountId(); @@ -8297,16 +8313,19 @@ export class JMAPClient implements IJMAPClient { isShared: !isPrimary, })); allContacts.push(...contacts); + answered += 1; } catch (error) { console.error(`Failed to fetch contacts for account ${accountId}:`, error); + failure ??= error; } } - return allContacts; + if (answered > 0 || !failure) return allContacts; } catch (error) { console.error('Failed to fetch all contacts:', error); return this.getContacts(); } + throw failure; } async getContact(contactId: string, accountId?: string): Promise { diff --git a/lib/store/__tests__/client-contacts.test.ts b/lib/store/__tests__/client-contacts.test.ts new file mode 100644 index 000000000..87d516a34 --- /dev/null +++ b/lib/store/__tests__/client-contacts.test.ts @@ -0,0 +1,113 @@ +// @vitest-environment node +/** + * The real JMAPClient reading the store's answers: what the client's own code + * makes of them is the contract, not the store's idea of the shape. + */ +import { afterEach, describe, expect, it } from 'vitest'; +import { JMAPClient } from '@/lib/jmap/client'; +import { setOfflineHooks, type OfflineHooks } from '@/lib/jmap/offline-hooks'; +import { DEFAULT_SCOPE } from '../area'; +import { contactsArea } from '../contacts'; +import { AccountEngine } from '../engine/account-engine'; +import { JMAP_ACCOUNT } from './helpers/fake-jmap'; +import { CONTACTS_SESSION, FakeContacts, SHARED_ACCOUNT } from './helpers/fake-contacts'; +import { openMemoryStore } from './helpers/node-adapter'; + +afterEach(() => setOfflineHooks(null)); + +async function offlineClient(server: FakeContacts): Promise<{ client: JMAPClient; engine: AccountEngine }> { + const engine = new AccountEngine({ + account: 'a@fake.test', + db: openMemoryStore(), + session: CONTACTS_SESSION, + transport: server, + areas: [contactsArea], + scope: DEFAULT_SCOPE, + sleep: async () => {}, + }); + await engine.requestSync(); + engine.setOnline(false); + const hooks: Partial = { + skipNetwork: () => true, + answer: (_client, calls) => engine.answer(calls), + record: () => {}, + noteNetwork: () => {}, + }; + setOfflineHooks(hooks as OfflineHooks); + const client = JMAPClient.fromOfflineSession('https://fake.test', 'a@example.org', { + ...CONTACTS_SESSION, + capabilities: { ...CONTACTS_SESSION.capabilities, 'urn:ietf:params:jmap:core': { maxObjectsInGet: 2 } }, + }); + return { client, engine }; +} + +function seeded(): FakeContacts { + const server = new FakeContacts(); + for (const full of ['Anna Bauer', 'Bernd Graf', 'Carla Müller']) server.addCard({ name: { full } }); + server.addBook({ id: 'teambook', name: 'Team' }, SHARED_ACCOUNT); + server.addCard({ id: 'c1', name: { full: 'Dora Team' }, addressBookIds: { teambook: true } }, SHARED_ACCOUNT); + return server; +} + +describe('the client over the store', () => { + it('reports a store that has nothing yet as a failure, not as no contacts', async () => { + const engine = new AccountEngine({ + account: 'a@fake.test', db: openMemoryStore(), session: CONTACTS_SESSION, transport: new FakeContacts(), + areas: [contactsArea], scope: DEFAULT_SCOPE, sleep: async () => {}, + }); + // Answered per call, with one more call the store can answer: the error isn't hidden by a null answer. + const perCall: Partial = { + skipNetwork: () => true, + answer: async (_client, calls) => (await engine.answer(calls)) ?? { + methodResponses: calls.map(([, , id]) => ['error', { type: 'serverUnavailable' }, id]), + }, + record: () => {}, + noteNetwork: () => {}, + }; + setOfflineHooks(perCall as OfflineHooks); + const client = JMAPClient.fromOfflineSession('https://fake.test', 'a@example.org', CONTACTS_SESSION); + await expect(client.getAllContacts()).rejects.toThrow(); + await expect(client.getAllAddressBooks()).rejects.toThrow(); + }); + + it('lists all contacts and books across accounts, paging in its own batch size', async () => { + const { client } = await offlineClient(seeded()); + const contacts = await client.getAllContacts(); + expect(contacts.map((c) => c.name?.full).sort()).toEqual(['Anna Bauer', 'Bernd Graf', 'Carla Müller', 'Dora Team']); + const shared = contacts.find((c) => c.name?.full === 'Dora Team'); + expect(shared).toMatchObject({ id: `${SHARED_ACCOUNT}:c1`, originalId: 'c1', isShared: true }); + const books = await client.getAllAddressBooks(); + expect(books.map((b) => b.id).sort()).toEqual(['book1', `${SHARED_ACCOUNT}:teambook`]); + }); + + it('searches with its own filter', async () => { + const { client } = await offlineClient(seeded()); + expect((await client.searchContacts('müll')).map((c) => c.name?.full)).toEqual(['Carla Müller']); + expect((await client.searchContacts('team')).map((c) => c.originalId)).toEqual(['c1']); + }); + + it('creates, edits and deletes through its own methods with the stand-in id', async () => { + const { client, engine } = await offlineClient(seeded()); + const created = await client.createContact({ name: { full: 'Neue Person' }, emails: { e: { address: 'neu@example.org' } } }); + expect(created.id).toBeTruthy(); + expect(created.addressBookIds).toEqual({ book1: true }); + await client.updateContact(created.id, { name: { full: 'Neue Person B' } }); + expect((await client.getContact(created.id))?.name?.full).toBe('Neue Person B'); + expect((await client.searchContacts('person b')).map((c) => c.id)).toEqual([created.id]); + await client.deleteContact(created.id); + expect(await client.getContact(created.id)).toBeNull(); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + }); + + it('throws the server-style error for an edit to a card it does not have', async () => { + const { client } = await offlineClient(seeded()); + await expect(client.updateContact('nope', { name: { full: 'X' } })).rejects.toThrow(); + await expect(client.deleteContact('nope')).rejects.toThrow(); + }); + + it('reads an account the store has as the primary contacts account', async () => { + const { client } = await offlineClient(seeded()); + expect(client.getContactsAccountId()).toBe(JMAP_ACCOUNT); + expect((await client.getContacts('book1')).length).toBe(3); + }); +}); diff --git a/stores/__tests__/contact-store.test.ts b/stores/__tests__/contact-store.test.ts index 1a6fb072d..f9dfabcca 100644 --- a/stores/__tests__/contact-store.test.ts +++ b/stores/__tests__/contact-store.test.ts @@ -9,7 +9,7 @@ import { normalizeContactPhotoUri, TRUSTED_SENDERS_BOOK_NAME, } from '../contact-store'; -import type { ContactCard, ContactMedia } from '@/lib/jmap/types'; +import type { AddressBook, ContactCard, ContactMedia } from '@/lib/jmap/types'; import type { IJMAPClient } from '@/lib/jmap/client-interface'; import { clearContactPhotoCache } from '@/lib/contact-photo-cache'; import { PrincipalsRequestError } from '@/lib/jmap/principals-error'; @@ -1364,6 +1364,38 @@ describe('contact-store', () => { }); }); + describe('an account that cannot answer', () => { + it('keeps its contacts and books while the other accounts refresh', async () => { + const failing = { + getAllContacts: vi.fn().mockRejectedValue(new Error('offline')), + getAllAddressBooks: vi.fn().mockRejectedValue(new Error('offline')), + } as unknown as IJMAPClient; + const working = { + getAllContacts: vi.fn().mockResolvedValue([makeContact({ id: 'b1' })]), + getAllAddressBooks: vi.fn().mockResolvedValue([{ id: 'bookb', name: 'B' }]), + } as unknown as IJMAPClient; + const kept = makeContact({ id: 'acc-a::a1', localAccountId: 'acc-a' }); + const keptBook = { id: 'acc-a::booka', name: 'A', localAccountId: 'acc-a' } as AddressBook; + useContactStore.setState({ contacts: [kept], addressBooks: [keptBook] }); + const accounts = [{ client: failing, localAccountId: 'acc-a' }, { client: working, localAccountId: 'acc-b' }]; + + await useContactStore.getState().fetchAllAccountsContacts(accounts); + await useContactStore.getState().fetchAllAccountsAddressBooks(accounts); + + const state = useContactStore.getState(); + expect(state.contacts.map((c) => c.id)).toEqual(['acc-a::a1', 'acc-b::b1']); + expect(state.addressBooks.map((b) => b.id)).toEqual(['acc-a::booka', 'acc-b::bookb']); + }); + + it('keeps the list when the only account fails', async () => { + const failing = { getAllContacts: vi.fn().mockRejectedValue(new Error('offline')) } as unknown as IJMAPClient; + useContactStore.setState({ contacts: [makeContact()] }); + await useContactStore.getState().fetchContacts(failing); + expect(useContactStore.getState().contacts).toHaveLength(1); + expect(useContactStore.getState().error).toBe('Failed to fetch contacts'); + }); + }); + describe('persistence/partialize', () => { it('should persist contacts when supportsSync is false', () => { const { partialize } = (useContactStore as unknown as { persist: { getOptions: () => { partialize: (state: Record) => Record } } }).persist.getOptions(); diff --git a/stores/contact-store.ts b/stores/contact-store.ts index cd10a91f7..3403088b2 100644 --- a/stores/contact-store.ts +++ b/stores/contact-store.ts @@ -671,7 +671,8 @@ export const useContactStore = create()( return prefixContactsWithLocalAccount(list, localAccountId); } catch (error) { debug.error(`Failed to fetch contacts for account ${localAccountId}:`, error); - return [] as ContactCard[]; + // Keep what this account's cards were: it just couldn't answer. + return get().contacts.filter((contact) => contact.localAccountId === localAccountId); } }), ); @@ -694,7 +695,7 @@ export const useContactStore = create()( return prefixAddressBooksWithLocalAccount(list, localAccountId); } catch (error) { debug.error(`Failed to fetch address books for account ${localAccountId}:`, error); - return [] as AddressBook[]; + return get().addressBooks.filter((book) => book.localAccountId === localAccountId); } }), ); From 698510fa08c18e5c15b741a09db6f522c8c316dd Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 05:47:39 +0100 Subject: [PATCH 03/20] feat: list files offline and keep pinned and recently opened files on the device --- lib/store/__tests__/client-files.test.ts | 88 ++++ lib/store/__tests__/files.test.ts | 535 ++++++++++++++++++++++ lib/store/__tests__/helpers/fake-files.ts | 192 ++++++++ lib/store/areas.ts | 3 +- lib/store/files/index.ts | 27 ++ lib/store/files/keep.ts | 295 ++++++++++++ lib/store/files/methods.ts | 108 +++++ lib/store/files/records.ts | 50 ++ lib/store/files/schema.ts | 47 ++ lib/store/files/sync.ts | 160 +++++++ 10 files changed, 1504 insertions(+), 1 deletion(-) create mode 100644 lib/store/__tests__/client-files.test.ts create mode 100644 lib/store/__tests__/files.test.ts create mode 100644 lib/store/__tests__/helpers/fake-files.ts create mode 100644 lib/store/files/index.ts create mode 100644 lib/store/files/keep.ts create mode 100644 lib/store/files/methods.ts create mode 100644 lib/store/files/records.ts create mode 100644 lib/store/files/schema.ts create mode 100644 lib/store/files/sync.ts diff --git a/lib/store/__tests__/client-files.test.ts b/lib/store/__tests__/client-files.test.ts new file mode 100644 index 000000000..08efd48d4 --- /dev/null +++ b/lib/store/__tests__/client-files.test.ts @@ -0,0 +1,88 @@ +// @vitest-environment node +/** + * The real JMAPClient listing files from the store, in each way a server says + * what a node is, plus what it does with a write. + */ +import { afterEach, describe, expect, it } from 'vitest'; +import { JMAPClient } from '@/lib/jmap/client'; +import { fileNodeKind } from '@/lib/jmap/filenode-kind'; +import { setOfflineHooks, type OfflineHooks } from '@/lib/jmap/offline-hooks'; +import { DEFAULT_SCOPE } from '../area'; +import { AccountEngine } from '../engine/account-engine'; +import { filesArea } from '../files'; +import { FakeFiles, FILES, FILES_SESSION, SHARED_FILES_ACCOUNT, type FakeFilesOptions } from './helpers/fake-files'; +import { openMemoryStore } from './helpers/node-adapter'; + +afterEach(() => setOfflineHooks(null)); + +async function offlineClient(server: FakeFiles): Promise { + const engine = new AccountEngine({ + account: 'a@fake.test', + db: openMemoryStore(), + session: FILES_SESSION, + transport: server, + areas: [filesArea], + scope: DEFAULT_SCOPE, + sleep: async () => {}, + }); + await engine.requestSync(); + engine.setOnline(false); + setOfflineHooks({ + skipNetwork: () => true, + answer: (_client, calls) => engine.answer(calls), + record: () => {}, + noteNetwork: () => {}, + } as Partial as OfflineHooks); + return JMAPClient.fromOfflineSession('https://fake.test', 'a@example.org', { + ...FILES_SESSION, + capabilities: { ...FILES_SESSION.capabilities, 'urn:ietf:params:jmap:core': { maxObjectsInGet: 500 } }, + }); +} + +describe('file listing offline', () => { + it.each<[string, FakeFilesOptions]>([ + ['nodeType (0.16.6 and later, 1.0 as tested)', { style: 'nodeType' }], + ['blobId null only (0.16.0-5)', { style: 'blob' }], + ['@type and mediaType (1.0.0)', { style: 'draft' }], + ])('tells folders from files: %s', async (_label, options) => { + const server = new FakeFiles(options); + const folder = server.addFolder('Docs'); + server.addFile('note.txt', folder.id); + const client = await offlineClient(server); + expect(client.supportsFiles()).toBe(true); + + const nodes = await client.listAllFileNodes(); + const byName = new Map(nodes.map((n) => [n.name, n])); + expect(fileNodeKind(byName.get('Docs') as never)).toBe('directory'); + expect(fileNodeKind(byName.get('note.txt') as never)).toBe('file'); + expect(byName.get('note.txt')).toMatchObject({ parentId: folder.id, type: 'text/plain', size: 10 }); + expect((await client.listFileNodes(folder.id)).map((n) => n.name)).toEqual(['note.txt']); + expect((await client.listFileNodes(null)).map((n) => n.name)).toEqual(['Docs']); + }); + + it('lists an account larger than one /get, ending its paging cleanly', async () => { + const server = new FakeFiles({ getAll: 'refuse' }); + const folder = server.addFolder('Docs'); + for (let i = 0; i < 700; i += 1) server.addFile(`f${i}`, folder.id); + const client = await offlineClient(server); + expect(await client.listAllFileNodes()).toHaveLength(701); + }); + + it('lists shared accounts with namespaced ids', async () => { + const server = new FakeFiles(); + server.addFolder('Mine'); + const shared = server.addFolder('Theirs', null, undefined, SHARED_FILES_ACCOUNT); + const client = await offlineClient(server); + const nodes = await client.listAllFileNodesAcrossAccounts(); + expect(nodes.find((n) => n.name === 'Theirs')).toMatchObject({ id: `${SHARED_FILES_ACCOUNT}:${shared.id}`, isShared: true }); + expect(nodes.find((n) => n.name === 'Mine')).toMatchObject({ isShared: false }); + }); + + it('fails a write with an error rather than losing it', async () => { + const server = new FakeFiles(); + const client = await offlineClient(server); + await expect(client.createFileDirectory('New', null)).rejects.toThrow(); + expect(FILES in FILES_SESSION.capabilities).toBe(true); + expect(server.calls.some(([n]) => n === 'FileNode/set')).toBe(false); + }); +}); diff --git a/lib/store/__tests__/files.test.ts b/lib/store/__tests__/files.test.ts new file mode 100644 index 000000000..acf81b483 --- /dev/null +++ b/lib/store/__tests__/files.test.ts @@ -0,0 +1,535 @@ +// @vitest-environment node +import { describe, expect, it } from 'vitest'; +import { DEFAULT_SCOPE, type StoreEvent, type StoreScope } from '../area'; +import { AccountEngine } from '../engine/account-engine'; +import { TransportError } from '../engine/transport'; +import { fileBlob, FILE_CACHE_CAP_BYTES, filesArea } from '../files'; +import type { StorageAdapter } from '../storage'; +import { JMAP_ACCOUNT } from './helpers/fake-jmap'; +import { FakeFiles, FILES_SESSION, SHARED_FILES_ACCOUNT } from './helpers/fake-files'; +import { openMemoryStore } from './helpers/node-adapter'; + +const NOW = Date.UTC(2026, 10, 3); + +/* eslint-disable @typescript-eslint/no-explicit-any -- answers are shaped like the server's */ + +interface Rig { + db: StorageAdapter; + engine: AccountEngine; + clock: { at: number }; + events: StoreEvent[]; +} + +function rigFor(server: FakeFiles, scope: Partial = {}): Rig { + const db = openMemoryStore(); + const clock = { at: NOW }; + const events: StoreEvent[] = []; + const engine = new AccountEngine({ + account: 'a@fake.test', + db, + session: FILES_SESSION, + transport: server, + areas: [filesArea], + scope: { ...DEFAULT_SCOPE, ...scope }, + emit: (event) => events.push(event), + now: () => clock.at, + sleep: async () => {}, + }); + return { db, engine, clock, events }; +} + +async function synced(server: FakeFiles, scope: Partial = {}): Promise { + const rig = rigFor(server, scope); + await rig.engine.requestSync(); + return rig; +} + +async function call(engine: AccountEngine, name: string, args: Record = {}): Promise { + const response = await engine.answer([[name, { accountId: JMAP_ACCOUNT, ...args }, '0']]); + if (!response) throw new Error('nothing answered'); + const [answered, result] = response.methodResponses[0]; + if (answered === 'error') throw new Error(result.type); + return result; +} + +const ref = (id: string, jmap = JMAP_ACCOUNT) => ({ jmap, id }); + +function names(rows: Array<{ name?: unknown }>): unknown[] { + return rows.map((row) => row.name).sort(); +} + +describe('file metadata sync', () => { + it('stores small accounts from one FileNode/get', async () => { + const server = new FakeFiles(); + const folder = server.addFolder('Docs'); + server.addFile('a.txt', folder.id); + const { engine } = await synced(server); + expect(server.calls.filter(([n]) => n === 'FileNode/query')).toHaveLength(0); + expect(names((await call(engine, 'FileNode/get', { ids: null })).list)).toEqual(['Docs', 'a.txt']); + }); + + it.each([ + ['0.16 cuts the list at 500', { getAll: 'cut' as const }], + ['1.0 refuses a list over 500', { getAll: 'refuse' as const }], + ])('pages past the /get limit: %s', async (_label, options) => { + const server = new FakeFiles(options); + const folder = server.addFolder('Docs'); + for (let i = 0; i < 1234; i += 1) server.addFile(`f${i}.txt`, folder.id); + const { db } = await synced(server); + expect(Number(db.get<{ n: number }>('SELECT COUNT(*) AS n FROM file_node')?.n)).toBe(1235); + for (const [name, args] of server.calls) { + if (name === 'FileNode/get' && Array.isArray(args.ids)) expect(args.ids.length).toBeLessThanOrEqual(500); + } + }); + + it('finds folders the query leaves out on old servers, by the parents of what it did find', async () => { + const server = new FakeFiles({ queryOmitsFolders: true, style: 'blob' }); + for (let i = 0; i < 600; i += 1) server.addFile(`early${i}.txt`); + const top = server.addFolder('Top'); + const inner = server.addFolder('Inner', top.id); + server.addFile('deep.txt', inner.id); + const { db } = await synced(server); + const kinds = db.all<{ name: string; kind: string }>("SELECT name, kind FROM file_node WHERE name IN ('Top', 'Inner', 'deep.txt') ORDER BY name"); + expect(kinds).toEqual([{ name: 'Inner', kind: 'directory' }, { name: 'Top', kind: 'directory' }, { name: 'deep.txt', kind: 'file' }]); + }); + + it('continues a stopped full sync from its cursor', async () => { + const server = new FakeFiles({ getAll: 'refuse' }); + for (let i = 0; i < 6000; i += 1) server.addFile(`f${i}`); + const rig = rigFor(server); + let gets = 0; + server.beforeRequest = () => { + gets += 1; + // State capture, the refused list, a query page of 5000 and two requests of gets: then the network goes. + if (gets === 6) server.offline = true; + }; + await rig.engine.requestSync(); + expect(Number(rig.db.get<{ n: number }>('SELECT COUNT(*) AS n FROM file_node')?.n)).toBe(5000); + server.offline = false; + server.beforeRequest = null; + server.calls.length = 0; + await rig.engine.requestSync(); + expect(Number(rig.db.get<{ n: number }>('SELECT COUNT(*) AS n FROM file_node')?.n)).toBe(6000); + expect(server.calls.find(([n]) => n === 'FileNode/query')?.[1].position).toBe(5000); + expect(server.calls.filter(([n, a]) => n === 'FileNode/get' && a.ids === null && a.accountId === JMAP_ACCOUNT)).toHaveLength(0); + }); + + it('follows changes through FileNode/changes', async () => { + const server = new FakeFiles(); + const a = server.addFile('a.txt'); + const b = server.addFile('b.txt'); + const { engine } = await synced(server); + server.calls.length = 0; + server.renameNode(a.id, 'renamed.txt'); + server.removeNode(b.id); + server.addFolder('New'); + await engine.requestSync(); + expect(server.calls.some(([n]) => n === 'FileNode/changes')).toBe(true); + expect(server.calls.some(([n, args]) => n === 'FileNode/get' && args.ids === null)).toBe(false); + expect(names((await call(engine, 'FileNode/get', { ids: null })).list)).toEqual(['New', 'renamed.txt']); + }); + + it('starts over when the server can no longer give changes, and keeps a pin on a file still there', async () => { + const server = new FakeFiles(); + const gone = server.addFile('gone.txt'); + const kept = server.addFile('kept.txt'); + const { db, engine } = await synced(server); + await engine.areaCall('files.pin', ref(kept.id)); + await engine.requestSync(); + server.removeNode(gone.id); + server.account().coll.truncatedBelow = server.account().coll.log.length; + await engine.requestSync(); + expect(db.all('SELECT id FROM file_node').map((r) => r.id)).toEqual([kept.id]); + expect(db.get<{ pinned: number }>('SELECT pinned FROM file_node WHERE id = ?', [kept.id])?.pinned).toBe(1); + }); + + it('keeps accounts apart, even with the same ids', async () => { + const server = new FakeFiles(); + server.addFile('own.txt', null, 5, { id: 'same' }); + server.addFile('team.txt', null, 5, { id: 'same', blobId: 'team-blob' }, SHARED_FILES_ACCOUNT); + const { engine } = await synced(server); + expect(names((await call(engine, 'FileNode/get', { ids: ['same'] })).list)).toEqual(['own.txt']); + expect(names((await call(engine, 'FileNode/get', { ids: ['same'], accountId: SHARED_FILES_ACCOUNT })).list)).toEqual(['team.txt']); + }); +}); + +describe('file answers', () => { + it('says so instead of an empty list when nothing was read yet', async () => { + const { engine } = rigFor(new FakeFiles()); + expect(await engine.answer([['FileNode/get', { accountId: JMAP_ACCOUNT, ids: null }, '0']])).toBeNull(); + }); + + it('gives the last server state and only asked-for properties', async () => { + const server = new FakeFiles(); + const file = server.addFile('a.txt'); + const { engine } = await synced(server); + const got = await call(engine, 'FileNode/get', { ids: [file.id, 'nope'], properties: ['name', 'parentId'] }); + expect(got.state).toBe(server.account().coll.state()); + expect(got.list).toEqual([{ id: file.id, name: 'a.txt', parentId: null }]); + expect(got.notFound).toEqual(['nope']); + }); + + it('answers a query by parent, also at the root, which the real server refuses to take', async () => { + const server = new FakeFiles(); + const folder = server.addFolder('Docs'); + const inside = server.addFile('in.txt', folder.id); + const root = server.addFile('root.txt'); + const { engine } = await synced(server); + expect((await call(engine, 'FileNode/query', { filter: { parentId: folder.id } })).ids).toEqual([inside.id]); + expect((await call(engine, 'FileNode/query', { filter: { parentId: null } })).ids).toEqual([folder.id, root.id]); + }); + + it('pages and sorts a query', async () => { + const server = new FakeFiles(); + server.addFile('b', null, 30); + server.addFile('a', null, 10); + server.addFile('c', null, 20); + const { engine } = await synced(server); + const page = await call(engine, 'FileNode/query', { filter: {}, position: 1, limit: 1, calculateTotal: true }); + expect(page).toMatchObject({ position: 1, total: 3, ids: [expect.any(String)] }); + const bySize = await call(engine, 'FileNode/query', { filter: {}, sort: [{ property: 'size', isAscending: false }] }); + const list = (await call(engine, 'FileNode/get', { ids: bySize.ids })).list; + expect(list.map((n: { name: string }) => n.name)).toEqual(['b', 'c', 'a']); + }); + + it('refuses what it cannot read, for that call only', async () => { + const server = new FakeFiles(); + server.addFile('a'); + const { engine } = await synced(server); + const response = await engine.answer([ + ['FileNode/query', { accountId: JMAP_ACCOUNT, filter: { hasFoo: true } }, '0'], + ['FileNode/get', { accountId: JMAP_ACCOUNT, ids: null }, '1'], + ]); + expect(response?.methodResponses[0][1].type).toBe('unsupportedFilter'); + expect(response?.methodResponses[1][0]).toBe('FileNode/get'); + }); + + it('answers FileNode/set with a clear per-call error, not silence', async () => { + const server = new FakeFiles(); + server.addFile('a'); + const { engine } = await synced(server); + const response = await engine.answer([ + ['FileNode/set', { accountId: JMAP_ACCOUNT, create: { n0: { name: 'x' } } }, '0'], + ['FileNode/get', { accountId: JMAP_ACCOUNT, ids: null }, '1'], + ]); + expect(response?.methodResponses[0]).toEqual(['error', { type: 'serverUnavailable', description: 'FileNode/set needs the server' }, '0']); + expect(response?.methodResponses[1][0]).toBe('FileNode/get'); + expect(server.calls.some(([n]) => n === 'FileNode/set')).toBe(false); + }); +}); + +describe('pinned files', () => { + it('fetches a pinned file and gives it back byte for byte, past the chunk size', async () => { + const server = new FakeFiles(); + const content = new Uint8Array(3 * 1024 * 1024 + 17).map((_, i) => i % 251); + const file = server.addFile('big.bin', null, content); + const { db, engine } = await synced(server); + expect(server.downloads).toEqual([]); + + expect(await engine.areaCall('files.pin', ref(file.id))).toEqual({ kept: false }); + await engine.requestSync(); + expect(server.downloads).toEqual([{ jmap: JMAP_ACCOUNT, blobId: file.blobId }]); + expect(Number(db.get<{ n: number }>('SELECT COUNT(*) AS n FROM file_blob_chunk')?.n)).toBe(4); + + const read = await engine.areaCall('files.read', ref(file.id)) as any; + expect(read.name).toBe('big.bin'); + expect(read.type).toBe('text/plain'); + expect(Buffer.compare(read.data, content)).toBe(0); + expect(Buffer.compare(fileBlob({ db }, JMAP_ACCOUNT, file.blobId as string)?.data as Uint8Array, content)).toBe(0); + expect(await engine.areaCall('files.blob', { jmap: JMAP_ACCOUNT, blobId: file.blobId })).toMatchObject({ size: content.length }); + // Already kept: not fetched again. + await engine.requestSync(); + expect(server.downloads).toHaveLength(1); + expect(await engine.areaCall('files.pin', ref(file.id))).toEqual({ kept: true }); + }); + + it('names a file with a %-encoded name from 0.16 WebDAV the way the client shows it', async () => { + const server = new FakeFiles(); + const file = server.addFile('My%20Report.pdf'); + const { engine } = await synced(server); + await engine.areaCall('files.pin', ref(file.id)); + await engine.requestSync(); + expect((await engine.areaCall('files.read', ref(file.id)) as any).name).toBe('My Report.pdf'); + expect((await engine.areaCall('files.kept', undefined) as any).files[0].name).toBe('My Report.pdf'); + // The stored node stays as the server sent it. The client decodes it once. + expect((await call(engine, 'FileNode/get', { ids: [file.id] })).list[0].name).toBe('My%20Report.pdf'); + }); + + it('gives nothing for a file not kept', async () => { + const server = new FakeFiles(); + const file = server.addFile('a.txt'); + const { db, engine } = await synced(server); + expect(await engine.areaCall('files.read', ref(file.id))).toBeNull(); + expect(fileBlob({ db }, JMAP_ACCOUNT, file.blobId as string)).toBeNull(); + }); + + it('refuses to pin a folder or an unknown id', async () => { + const server = new FakeFiles(); + const folder = server.addFolder('Docs'); + const { engine } = await synced(server); + await expect(engine.areaCall('files.pin', ref(folder.id))).rejects.toThrow('Only files'); + await expect(engine.areaCall('files.pin', ref('nope'))).rejects.toThrow(); + }); + + it('downloads one at a time', async () => { + const server = new FakeFiles(); + const files = [server.addFile('a'), server.addFile('b'), server.addFile('c')]; + const { engine } = await synced(server); + for (const file of files) await engine.areaCall('files.pin', ref(file.id)); + await engine.requestSync(); + expect(server.downloads).toHaveLength(3); + expect(server.mostAtOnce).toBe(1); + }); + + it('fetches a pinned file over the one-file limit, and skips an opened one', async () => { + const server = new FakeFiles(); + const pinned = server.addFile('pinned.bin', null, 100); + const opened = server.addFile('opened.bin', null, 100); + const { engine } = await synced(server, { maxAttachmentBytes: 50 }); + await engine.areaCall('files.pin', ref(pinned.id)); + await engine.areaCall('files.noteOpened', ref(opened.id)); + await engine.requestSync(); + expect(server.downloads.map((d) => d.blobId)).toEqual([pinned.blobId]); + const status = await engine.areaCall('files.kept', undefined) as any; + const row = (name: string) => status.files.find((f: { name: string }) => f.name === name); + expect(row('pinned.bin')).toMatchObject({ pinned: true, kept: true, error: null }); + expect(row('opened.bin')).toMatchObject({ pinned: false, kept: false, error: 'tooLarge' }); + }); + + it('does not take pins past the total limit, and says so', async () => { + const server = new FakeFiles(); + const a = server.addFile('a', null, 60); + const b = server.addFile('b', null, 60); + const { engine, clock } = await synced(server, { maxTotalBytes: 100 }); + await engine.areaCall('files.pin', ref(a.id)); + clock.at += 1; + await engine.areaCall('files.pin', ref(b.id)); + await engine.requestSync(); + expect(server.downloads).toHaveLength(1); + const status = await engine.areaCall('files.kept', undefined) as any; + expect(status.files.filter((f: { kept: boolean }) => f.kept)).toHaveLength(1); + expect(status.files.filter((f: { error: string | null }) => f.error === 'overLimit')).toHaveLength(1); + }); + + it('keeps nothing when the scope forbids it, and drops what was kept', async () => { + const server = new FakeFiles(); + const file = server.addFile('a'); + const rig = await synced(server); + await rig.engine.areaCall('files.pin', ref(file.id)); + await rig.engine.requestSync(); + expect(await rig.engine.areaCall('files.read', ref(file.id))).not.toBeNull(); + + rig.engine.setScope({ ...DEFAULT_SCOPE, attachments: false }); + await rig.engine.requestSync(); + expect(await rig.engine.areaCall('files.read', ref(file.id))).toBeNull(); + expect(Number(rig.db.get<{ n: number }>('SELECT COUNT(*) AS n FROM file_blob_chunk')?.n)).toBe(0); + expect((await rig.engine.areaCall('files.kept', undefined) as any).files[0]).toMatchObject({ pinned: true, kept: false, error: 'notAllowed' }); + + rig.engine.setScope(DEFAULT_SCOPE); + await rig.engine.requestSync(); + expect(await rig.engine.areaCall('files.read', ref(file.id))).not.toBeNull(); + }); + + it('goes by the real size when the metadata has it wrong', async () => { + const server = new FakeFiles(); + const opened = server.addFile('opened', null, new Uint8Array(100), { size: 1 }); + const { engine } = await synced(server, { maxAttachmentBytes: 50 }); + await engine.areaCall('files.noteOpened', ref(opened.id)); + await engine.requestSync(); + expect(server.downloads).toHaveLength(1); + expect(await engine.areaCall('files.read', ref(opened.id))).toBeNull(); + expect((await engine.areaCall('files.kept', undefined) as any).files[0].error).toBe('tooLarge'); + }); + + it('does not store a file unpinned while it was downloading', async () => { + const server = new FakeFiles(); + const file = server.addFile('a'); + const { engine } = await synced(server); + await engine.areaCall('files.pin', ref(file.id)); + const original = server.download.bind(server); + server.download = async (jmap, blobId) => { + await engine.areaCall('files.unpin', ref(file.id)); + return original(jmap, blobId); + }; + await engine.requestSync(); + expect(server.downloads).toHaveLength(1); + expect(await engine.areaCall('files.read', ref(file.id))).toBeNull(); + }); + + it('lets a never-opened file go on unpin, and keeps an opened one as recent', async () => { + const server = new FakeFiles(); + const never = server.addFile('never'); + const opened = server.addFile('opened'); + const { engine } = await synced(server); + await engine.areaCall('files.pin', ref(never.id)); + await engine.areaCall('files.pin', ref(opened.id)); + await engine.areaCall('files.noteOpened', ref(opened.id)); + await engine.requestSync(); + await engine.areaCall('files.unpin', ref(never.id)); + await engine.areaCall('files.unpin', ref(opened.id)); + expect(await engine.areaCall('files.read', ref(never.id))).toBeNull(); + expect(await engine.areaCall('files.read', ref(opened.id))).not.toBeNull(); + const status = await engine.areaCall('files.kept', undefined) as any; + expect(status.files.map((f: { name: string; pinned: boolean }) => [f.name, f.pinned])).toEqual([['opened', false]]); + }); + + it('drops the old content and fetches the new one when a pinned file changes', async () => { + const server = new FakeFiles(); + const file = server.addFile('a.txt', null, new Uint8Array([1, 2, 3])); + const { db, engine } = await synced(server); + await engine.areaCall('files.pin', ref(file.id)); + await engine.requestSync(); + const old = file.blobId as string; + const fresh = server.replaceContent(file.id, new Uint8Array([9, 9])); + await engine.requestSync(); + expect(fileBlob({ db }, JMAP_ACCOUNT, old)).toBeNull(); + expect([...(fileBlob({ db }, JMAP_ACCOUNT, fresh)?.data ?? [])]).toEqual([9, 9]); + expect(Array.from((await engine.areaCall('files.read', ref(file.id)) as any).data)).toEqual([9, 9]); + }); + + it('drops the content when the file is removed on the server, unless another node shares it', async () => { + const server = new FakeFiles(); + const a = server.addFile('a', null, 5, { blobId: 'shared-blob' }); + const b = server.addFile('b', null, 5, { blobId: 'shared-blob' }); + const { db, engine } = await synced(server); + await engine.areaCall('files.pin', ref(a.id)); + await engine.areaCall('files.pin', ref(b.id)); + await engine.requestSync(); + expect(server.downloads).toHaveLength(1); + server.removeNode(a.id); + await engine.requestSync(); + expect(fileBlob({ db }, JMAP_ACCOUNT, 'shared-blob')).not.toBeNull(); + server.removeNode(b.id); + await engine.requestSync(); + expect(fileBlob({ db }, JMAP_ACCOUNT, 'shared-blob')).toBeNull(); + expect(Number(db.get<{ n: number }>('SELECT COUNT(*) AS n FROM file_blob_chunk')?.n)).toBe(0); + }); + + it('carries on past one bad file, and hands a network failure to the engine', async () => { + const server = new FakeFiles(); + const bad = server.addFile('bad'); + const good = server.addFile('good'); + server.blobs.delete(bad.blobId as string); + const { engine, clock } = await synced(server); + await engine.areaCall('files.pin', ref(bad.id)); + clock.at += 1; + await engine.areaCall('files.pin', ref(good.id)); + await engine.requestSync(); + expect(await engine.areaCall('files.read', ref(good.id))).not.toBeNull(); + const status = await engine.areaCall('files.kept', undefined) as any; + expect(status.files.find((f: { name: string }) => f.name === 'bad').error).toBe('download'); + + }); + + it('hands a network failure to the engine, which ends the pass, and goes on next time', async () => { + const server = new FakeFiles(); + const file = server.addFile('a'); + const rig = await synced(server); + await rig.engine.areaCall('files.pin', ref(file.id)); + const original = server.download.bind(server); + server.download = async () => { + throw new TransportError('network', 'Failed to fetch'); + }; + const syncedBefore = rig.events.filter((e) => e.type === 'synced').length; + await rig.engine.requestSync(); + expect(rig.events.some((e) => e.type === 'error')).toBe(false); + expect(rig.events.filter((e) => e.type === 'synced').length).toBe(syncedBefore); + expect((await rig.engine.areaCall('files.kept', undefined) as any).files[0]).toMatchObject({ kept: false, error: null }); + + server.download = original; + await rig.engine.requestSync(); + expect(await rig.engine.areaCall('files.read', ref(file.id))).not.toBeNull(); + }); +}); + +describe('recently opened files', () => { + it('keeps an opened file without a pin', async () => { + const server = new FakeFiles(); + const file = server.addFile('a'); + const { engine } = await synced(server); + expect(await engine.areaCall('files.noteOpened', ref(file.id))).toEqual({ kept: false }); + await engine.requestSync(); + expect(await engine.areaCall('files.read', ref(file.id))).not.toBeNull(); + expect(await engine.areaCall('files.noteOpened', ref(file.id))).toEqual({ kept: true }); + }); + + it('pushes out the oldest unpinned first, and never a pinned one', async () => { + const server = new FakeFiles(); + const files = Object.fromEntries(['old', 'pinnedOldest', 'mid', 'new', 'newest'].map((name) => [name, server.addFile(name, null, 10)])); + const rig = await synced(server, { maxTotalBytes: 30 }); + const open = async (name: string) => { + rig.clock.at += 1000; + await rig.engine.areaCall('files.noteOpened', ref(files[name].id)); + await rig.engine.requestSync(); + }; + await open('pinnedOldest'); + await rig.engine.areaCall('files.pin', ref(files.pinnedOldest.id)); + await open('old'); + await open('mid'); + const kept = async () => (await rig.engine.areaCall('files.kept', undefined) as any).files + .filter((f: { kept: boolean }) => f.kept).map((f: { name: string }) => f.name).sort(); + expect(await kept()).toEqual(['mid', 'old', 'pinnedOldest']); + + await open('new'); + expect(await kept()).toEqual(['mid', 'new', 'pinnedOldest']); + await open('mid'); + await open('newest'); + expect(await kept()).toEqual(['mid', 'newest', 'pinnedOldest']); + expect((await rig.engine.areaCall('files.kept', undefined) as any).bytes).toBe(30); + + // A pinned file was never pushed out and had to come back. + expect(server.downloads.filter((d) => d.blobId === files.pinnedOldest.blobId)).toHaveLength(1); + // Pushed out means forgotten: the next pass doesn't fetch it straight back. + expect(server.downloads.filter((d) => d.blobId === files.old.blobId)).toHaveLength(1); + const count = server.downloads.length; + await rig.engine.requestSync(); + expect(server.downloads).toHaveLength(count); + expect((await rig.engine.areaCall('files.kept', undefined) as any).files.map((f: { name: string }) => f.name)).not.toContain('old'); + }); + + it('pushes out recent files for a pin, and keeps a pin past the cap', async () => { + const server = new FakeFiles(); + const recent = server.addFile('recent', null, 20); + const pin = server.addFile('pin', null, 20); + const rig = await synced(server, { maxTotalBytes: 25 }); + await rig.engine.areaCall('files.noteOpened', ref(recent.id)); + await rig.engine.requestSync(); + rig.clock.at += 1000; + await rig.engine.areaCall('files.pin', ref(pin.id)); + await rig.engine.requestSync(); + expect(await rig.engine.areaCall('files.read', ref(recent.id))).toBeNull(); + expect(await rig.engine.areaCall('files.read', ref(pin.id))).not.toBeNull(); + }); + + it('keeps recently opened files under 500 MB whatever the total limit is', async () => { + const server = new FakeFiles(); + const file = server.addFile('new', null, 10); + const rig = await synced(server, { maxTotalBytes: 2 * FILE_CACHE_CAP_BYTES }); + // As if an older file already took all of it: only the row counts here. + rig.db.run('INSERT INTO file_blob (jmap, blob_id, type, size, kept_at) VALUES (?, ?, ?, ?, ?)', [JMAP_ACCOUNT, 'huge', 'x', FILE_CACHE_CAP_BYTES, NOW - 1000]); + rig.db.run("INSERT INTO file_node (jmap, id, name, kind, blob_id, size, json, opened_at) VALUES (?, 'hugenode', 'huge', 'file', 'huge', ?, '{}', ?)", [JMAP_ACCOUNT, FILE_CACHE_CAP_BYTES, NOW - 1000]); + await rig.engine.areaCall('files.noteOpened', ref(file.id)); + await rig.engine.requestSync(); + expect(fileBlob({ db: rig.db }, JMAP_ACCOUNT, 'huge')).toBeNull(); + expect(await rig.engine.areaCall('files.read', ref(file.id))).not.toBeNull(); + expect((await rig.engine.areaCall('files.kept', undefined) as any).capBytes).toBe(FILE_CACHE_CAP_BYTES); + }); + + it('drops an old opened file that does not fit rather than a newer one', async () => { + const server = new FakeFiles(); + const a = server.addFile('a', null, 20); + const b = server.addFile('b', null, 20); + const rig = await synced(server, { maxTotalBytes: 25 }); + await rig.engine.areaCall('files.noteOpened', ref(a.id)); + rig.clock.at += 1000; + await rig.engine.areaCall('files.noteOpened', ref(b.id)); + await rig.engine.requestSync(); + expect(await rig.engine.areaCall('files.read', ref(b.id))).not.toBeNull(); + expect(await rig.engine.areaCall('files.read', ref(a.id))).toBeNull(); + expect(server.downloads.map((d) => d.blobId)).toEqual([b.blobId, a.blobId]); + const count = server.downloads.length; + await rig.engine.requestSync(); + expect(server.downloads).toHaveLength(count); + }); +}); +/* eslint-enable @typescript-eslint/no-explicit-any */ diff --git a/lib/store/__tests__/helpers/fake-files.ts b/lib/store/__tests__/helpers/fake-files.ts new file mode 100644 index 000000000..0ff22f4ed --- /dev/null +++ b/lib/store/__tests__/helpers/fake-files.ts @@ -0,0 +1,192 @@ +/** + * FakeJmap with files, as measured on both Stalwarts (2026-11-03) and as the + * client's comments record: `filter: {parentId: null}` is an HTTP 400 that + * fails the whole request, a folder has null blobId, type and size. What differs + * between versions is set per server: + * - `style` is how a node says what it is: `nodeType` (0.16.6 and later, 1.0 as + * tested), `blob` (0.16.0-5: nothing but blobId null), `draft` (1.0.0: `@type` + * and `mediaType`). + * - `getAll`: ids null past 500 is silently cut on 0.16 and refused on 1.0. + * - `queryOmitsFolders`: FileNode/query before 0.16.6. + */ + +import { TransportError, type StoreSession } from '../../engine/transport'; +import { changesFor } from './fake-contacts'; +import { Collection, FAKE_SESSION, FakeJmap, JMAP_ACCOUNT } from './fake-jmap'; + +export const FILES = 'urn:ietf:params:jmap:filenode'; +export const SHARED_FILES_ACCOUNT = 'shared1'; + +export const FILES_SESSION: StoreSession = { + ...FAKE_SESSION, + primaryAccounts: { ...FAKE_SESSION.primaryAccounts, [FILES]: JMAP_ACCOUNT }, + accounts: { + [JMAP_ACCOUNT]: { name: 'a@example.org', isPersonal: true, accountCapabilities: { [FILES]: {} } }, + [SHARED_FILES_ACCOUNT]: { name: 'team@example.org', isPersonal: false, accountCapabilities: { [FILES]: {} } }, + }, + capabilities: { [FILES]: {} }, +}; + +export interface FakeNode { + id: string; + parentId: string | null; + name: string; + blobId: string | null; + type: string | null; + size: number | null; + modified?: string; +} + +export type FolderStyle = 'nodeType' | 'blob' | 'draft'; + +export interface FakeFilesOptions { + style?: FolderStyle; + getAll?: 'cut' | 'refuse'; + queryOmitsFolders?: boolean; +} + +class FilesAccount { + readonly nodes = new Map(); + readonly coll = new Collection(); +} + +export class FakeFiles extends FakeJmap { + private readonly fileAccounts = new Map(); + private readonly options: Required; + private nextNode = 1; + readonly blobs = new Map(); + /** In order, with the account. */ + readonly downloads: Array<{ jmap: string; blobId: string }> = []; + downloading = 0; + mostAtOnce = 0; + + constructor(options: FakeFilesOptions = {}) { + super(); + this.options = { style: 'nodeType', getAll: 'cut', queryOmitsFolders: false, ...options }; + } + + account(id: string = JMAP_ACCOUNT): FilesAccount { + let found = this.fileAccounts.get(id); + if (!found) { + found = new FilesAccount(); + this.fileAccounts.set(id, found); + } + return found; + } + + addFolder(name: string, parentId: string | null = null, id?: string, accountId: string = JMAP_ACCOUNT): FakeNode { + const account = this.account(accountId); + const node: FakeNode = { id: id ?? `n${this.nextNode++}`, parentId, name, blobId: null, type: null, size: null }; + account.nodes.set(node.id, node); + account.coll.push('created', node.id); + return node; + } + + addFile(name: string, parentId: string | null = null, content: Uint8Array | number = 10, extra: Partial = {}, accountId: string = JMAP_ACCOUNT): FakeNode { + const account = this.account(accountId); + const id = extra.id ?? `n${this.nextNode++}`; + const blobId = extra.blobId ?? `blob-${id}`; + const data = typeof content === 'number' ? new Uint8Array(content).fill(id.length) : content; + this.blobs.set(blobId, data); + const node: FakeNode = { id, parentId, name, blobId, type: 'text/plain', size: data.length, ...extra }; + account.nodes.set(id, node); + account.coll.push('created', id); + return node; + } + + /** A new version of the file: new blob, same node. */ + replaceContent(id: string, content: Uint8Array, accountId: string = JMAP_ACCOUNT): string { + const account = this.account(accountId); + const node = account.nodes.get(id) as FakeNode; + const blobId = `${node.blobId as string}-v`; + this.blobs.set(blobId, content); + node.blobId = blobId; + node.size = content.length; + account.coll.push('updated', id); + return blobId; + } + + renameNode(id: string, name: string, accountId: string = JMAP_ACCOUNT): void { + const account = this.account(accountId); + (account.nodes.get(id) as FakeNode).name = name; + account.coll.push('updated', id); + } + + removeNode(id: string, accountId: string = JMAP_ACCOUNT): void { + const account = this.account(accountId); + account.nodes.delete(id); + account.coll.push('destroyed', id); + } + + private wire(node: FakeNode, properties: string[] | undefined): Record { + const isFolder = node.blobId === null; + const full: Record = { id: node.id, parentId: node.parentId, name: node.name, blobId: node.blobId, size: node.size, created: '2026-10-01T00:00:00Z', modified: node.modified ?? '2026-10-01T00:00:00Z' }; + if (this.options.style === 'draft') { + full['@type'] = isFolder ? 'Directory' : 'File'; + full.mediaType = node.type; + } else { + full.type = node.type; + if (this.options.style === 'nodeType') full.nodeType = isFolder ? 'directory' : 'file'; + } + if (!properties) return full; + const out: Record = { id: node.id }; + for (const p of properties) if (p in full) out[p] = full[p]; + return out; + } + + protected override handle(name: string, args: Record): Record { + if (!name.startsWith('FileNode/')) return super.handle(name, args); + const account = this.account(String(args.accountId)); + switch (name) { + case 'FileNode/changes': + return changesFor(account.coll, args); + case 'FileNode/get': { + const ids = args.ids as string[] | null; + if (ids && ids.length > 500) throw Object.assign(new Error('requestTooLarge'), { jmapError: 'requestTooLarge' }); + if (!ids && account.nodes.size > 500 && this.options.getAll === 'refuse') { + throw Object.assign(new Error('requestTooLarge'), { jmapError: 'requestTooLarge' }); + } + const chosen = ids ?? [...account.nodes.keys()].slice(0, 500); + const properties = args.properties as string[] | undefined; + return { + accountId: args.accountId, + state: account.coll.state(), + list: chosen.filter((id) => account.nodes.has(id)).map((id) => this.wire(account.nodes.get(id) as FakeNode, properties)), + notFound: chosen.filter((id) => !account.nodes.has(id)), + }; + } + case 'FileNode/query': { + const filter = (args.filter ?? {}) as { parentId?: string | null }; + // Measured on both servers: this fails the whole request. + if (filter.parentId === null) throw new TransportError('http', 'JMAP request failed: 400', 400, 'urn:ietf:params:jmap:error:notRequest'); + let list = [...account.nodes.values()]; + if (this.options.queryOmitsFolders) list = list.filter((n) => n.blobId !== null); + if (filter.parentId) list = list.filter((n) => n.parentId === filter.parentId); + const position = Number(args.position ?? 0); + const limit = Math.min(Number(args.limit ?? 5000) || 5000, 5000); + return { + accountId: args.accountId, + queryState: account.coll.state(), + canCalculateChanges: true, + position, + ids: list.slice(position, position + limit).map((n) => n.id), + ...(args.calculateTotal ? { total: list.length } : {}), + }; + } + default: + throw Object.assign(new Error(name), { jmapError: 'unknownMethod' }); + } + } + + override async download(jmap: string, blobId: string): Promise { + if (this.offline) throw new TransportError('network', 'Failed to fetch'); + this.downloads.push({ jmap, blobId }); + this.downloading += 1; + this.mostAtOnce = Math.max(this.mostAtOnce, this.downloading); + await Promise.resolve(); + this.downloading -= 1; + const data = this.blobs.get(blobId); + if (!data) throw new TransportError('http', 'Download failed: 404', 404); + return data; + } +} diff --git a/lib/store/areas.ts b/lib/store/areas.ts index c8882f3ee..7fb966931 100644 --- a/lib/store/areas.ts +++ b/lib/store/areas.ts @@ -2,6 +2,7 @@ import type { StoreArea } from './area'; import { contactsArea } from './contacts'; +import { filesArea } from './files'; import { mailArea } from './mail'; -export const STORE_AREAS: readonly StoreArea[] = [mailArea, contactsArea]; +export const STORE_AREAS: readonly StoreArea[] = [mailArea, contactsArea, filesArea]; diff --git a/lib/store/files/index.ts b/lib/store/files/index.ts new file mode 100644 index 000000000..0957ced89 --- /dev/null +++ b/lib/store/files/index.ts @@ -0,0 +1,27 @@ +import type { StoreArea } from '../area'; +import { fileBlob, keptStatus, noteOpened, pinFile, readFile, unpinFile, type NodeRef } from './keep'; +import { FILE_METHODS } from './methods'; +import { FILE_MIGRATIONS } from './schema'; +import { filesSyncer } from './sync'; + +export { fileBlob, FILE_CACHE_CAP_BYTES } from './keep'; + +export const filesArea: StoreArea = { + name: 'files', + migrations: FILE_MIGRATIONS, + methods: FILE_METHODS, + syncers: [filesSyncer], + calls: { + /** Keep this file's content on the device until it's unpinned. */ + 'files.pin': (ctx, params: NodeRef) => pinFile(ctx, params), + 'files.unpin': (ctx, params: NodeRef) => unpinFile(ctx, params), + /** The page opened this file: keep its content for a while. */ + 'files.noteOpened': (ctx, params: NodeRef) => noteOpened(ctx, params), + /** A kept file's content and name, or null. */ + 'files.read': (ctx, params: NodeRef) => readFile(ctx, params), + /** A kept content by blob id, or null. */ + 'files.blob': (ctx, params: { jmap: string; blobId: string }) => fileBlob(ctx, params.jmap, params.blobId), + /** Pinned and recently opened files, for a settings page. */ + 'files.kept': (ctx) => keptStatus(ctx), + }, +}; diff --git a/lib/store/files/keep.ts b/lib/store/files/keep.ts new file mode 100644 index 000000000..a11b93455 --- /dev/null +++ b/lib/store/files/keep.ts @@ -0,0 +1,295 @@ +/** + * File contents kept on the device: pinned files, and recently opened ones + * within a cap. Metadata for every file is in file_node regardless. + * + * What gets kept: + * - A pinned file stays until it's unpinned or removed on the server. The cap + * doesn't push it out and the size limit for one file doesn't apply. The + * account's total limit (scope.maxTotalBytes, which a policy can lower) does. + * - A recently opened file is kept if it's within scope.maxAttachmentBytes, and + * pushed out oldest first when the cap is reached. Its opened_at goes with + * it, so it isn't fetched straight back. + * - With scope.attachments off, nothing is kept. + */ + +import { TransportError } from '../engine/transport'; +import { MethodError, type StoreContext, type SyncContext } from '../area'; +import type { StorageAdapter } from '../storage'; +import { nodeMediaType, type WireNode } from './records'; + +export const FILE_CACHE_CAP_BYTES = 500 * 1024 * 1024; +const CHUNK_BYTES = 1024 * 1024; + +export interface KeptFile { data: Uint8Array; type: string; size: number } + +export interface NodeRef { jmap: string; id: string } + +interface NodeRow { + jmap: string; + id: string; + name: string; + kind: string; + blob_id: string | null; + size: number | null; + json: string; + pinned: number; + opened_at: number | null; + keep_error: string | null; +} + +interface BlobRow { + jmap: string; + blob_id: string; + size: number; + kept_at: number; + pinned: number; + opened_at: number | null; +} + +function capBytes(ctx: Pick): number { + return Math.min(FILE_CACHE_CAP_BYTES, ctx.scope.maxTotalBytes); +} + +/** A kept file's content, for the client's blob lookup. */ +export function fileBlob(ctx: Pick, jmap: string, blobId: string): KeptFile | null { + const row = ctx.db.get<{ type: string; size: number }>('SELECT type, size FROM file_blob WHERE jmap = ? AND blob_id = ?', [jmap, blobId]); + if (!row) return null; + const data = new Uint8Array(Number(row.size)); + let at = 0; + for (const chunk of ctx.db.all<{ data: Uint8Array }>('SELECT data FROM file_blob_chunk WHERE jmap = ? AND blob_id = ? ORDER BY seq', [jmap, blobId])) { + data.set(chunk.data, at); + at += chunk.data.length; + } + return { data, type: row.type, size: Number(row.size) }; +} + +function hasBlob(db: StorageAdapter, jmap: string, blobId: string): boolean { + return Boolean(db.get('SELECT 1 AS x FROM file_blob WHERE jmap = ? AND blob_id = ?', [jmap, blobId])); +} + +function dropBlob(db: StorageAdapter, jmap: string, blobId: string): void { + db.run('DELETE FROM file_blob_chunk WHERE jmap = ? AND blob_id = ?', [jmap, blobId]); + db.run('DELETE FROM file_blob WHERE jmap = ? AND blob_id = ?', [jmap, blobId]); +} + +function storeBlob(ctx: StoreContext, jmap: string, blobId: string, type: string, data: Uint8Array): void { + dropBlob(ctx.db, jmap, blobId); + ctx.db.run('INSERT INTO file_blob (jmap, blob_id, type, size, kept_at) VALUES (?, ?, ?, ?, ?)', [jmap, blobId, type, data.length, ctx.now()]); + for (let seq = 0, at = 0; at < data.length; seq += 1, at += CHUNK_BYTES) { + ctx.db.run('INSERT INTO file_blob_chunk (jmap, blob_id, seq, data) VALUES (?, ?, ?, ?)', [jmap, blobId, seq, data.subarray(at, at + CHUNK_BYTES)]); + } +} + +/** All kept contents in the store, with what the nodes pointing at each say about it. */ +function keptBlobs(db: StorageAdapter): BlobRow[] { + return db.all( + `SELECT b.jmap, b.blob_id, b.size, b.kept_at, COALESCE(MAX(n.pinned), 0) AS pinned, MAX(n.opened_at) AS opened_at + FROM file_blob b LEFT JOIN file_node n ON n.jmap = b.jmap AND n.blob_id = b.blob_id + GROUP BY b.jmap, b.blob_id`, + ); +} + +function ageOf(blob: BlobRow): number { + return Number(blob.opened_at ?? blob.kept_at); +} + +function pushOut(db: StorageAdapter, blob: BlobRow): void { + dropBlob(db, blob.jmap, blob.blob_id); + db.run('UPDATE file_node SET opened_at = NULL WHERE jmap = ? AND blob_id = ?', [blob.jmap, blob.blob_id]); +} + +/** + * Pushes out unpinned contents, oldest first, so `size` more fits under the + * cap. A recently opened file only pushes out older ones and says false when + * that isn't enough. A pinned one always gets in. + */ +function makeRoom(ctx: StoreContext, size: number, incoming: { pinned: boolean; openedAt: number }): boolean { + const cap = capBytes(ctx); + const blobs = keptBlobs(ctx.db); + let used = blobs.reduce((sum, blob) => sum + Number(blob.size), 0); + const candidates = blobs + .filter((blob) => !blob.pinned && (incoming.pinned || ageOf(blob) < incoming.openedAt)) + .sort((a, b) => ageOf(a) - ageOf(b)); + const chosen: BlobRow[] = []; + for (const blob of candidates) { + if (used + size <= cap) break; + used -= Number(blob.size); + chosen.push(blob); + } + if (used + size > cap && !incoming.pinned) return false; + for (const blob of chosen) pushOut(ctx.db, blob); + return true; +} + +function pinnedBytes(db: StorageAdapter): number { + return keptBlobs(db).filter((blob) => blob.pinned).reduce((sum, blob) => sum + Number(blob.size), 0); +} + +function setError(db: StorageAdapter, jmap: string, blobId: string, error: string | null): void { + db.run('UPDATE file_node SET keep_error = ? WHERE jmap = ? AND blob_id = ?', [error, jmap, blobId]); +} + +/** Contents no node points at any more: the file was removed or has a new version. */ +export function dropOrphanBlobs(db: StorageAdapter): void { + for (const blob of keptBlobs(db)) { + const used = db.get('SELECT 1 AS x FROM file_node WHERE jmap = ? AND blob_id = ?', [blob.jmap, blob.blob_id]); + if (!used) dropBlob(db, blob.jmap, blob.blob_id); + } +} + +interface Wanted { blob_id: string; id: string; name: string; size: number | null; json: string; pinned: number; opened_at: number | null } + +function wantedRow(db: StorageAdapter, jmap: string, blobId: string): Wanted | undefined { + return db.get( + `SELECT blob_id, id, name, size, json, pinned, opened_at FROM file_node + WHERE jmap = ? AND blob_id = ? AND (pinned = 1 OR opened_at IS NOT NULL) + ORDER BY pinned DESC, opened_at DESC LIMIT 1`, + [jmap, blobId], + ); +} + +/** Fetches what should be kept and isn't yet, one file at a time, pinned files first. */ +export async function fetchKeptFiles(ctx: SyncContext, jmap: string): Promise { + const { db } = ctx; + if (!ctx.scope.attachments) { + db.transaction(() => { + for (const blob of keptBlobs(db)) dropBlob(db, blob.jmap, blob.blob_id); + db.run("UPDATE file_node SET keep_error = 'notAllowed' WHERE jmap = ? AND (pinned = 1 OR opened_at IS NOT NULL)", [jmap]); + }); + return; + } + db.transaction(() => { + db.run("UPDATE file_node SET keep_error = NULL WHERE jmap = ? AND keep_error = 'notAllowed'", [jmap]); + // The limit may have gone down since last time. + makeRoom(ctx, 0, { pinned: true, openedAt: 0 }); + }); + const todo = db.all<{ blob_id: string }>( + `SELECT n.blob_id FROM file_node n + WHERE n.jmap = ? AND n.blob_id IS NOT NULL AND (n.pinned = 1 OR n.opened_at IS NOT NULL) + AND NOT EXISTS (SELECT 1 FROM file_blob b WHERE b.jmap = n.jmap AND b.blob_id = n.blob_id) + GROUP BY n.blob_id ORDER BY MAX(n.pinned) DESC, MAX(n.opened_at) DESC`, + [jmap], + ).map((row) => String(row.blob_id)); + let done = 0; + for (const blobId of todo) { + if (ctx.stopped()) return; + // The page may have changed its mind during the last download. + const want = wantedRow(db, jmap, blobId); + if (!want) continue; + const known = Number(want.size ?? 0); + if (!want.pinned && known > Math.min(ctx.scope.maxAttachmentBytes, capBytes(ctx))) { + setError(db, jmap, blobId, 'tooLarge'); + continue; + } + if (want.pinned && pinnedBytes(db) + known > ctx.scope.maxTotalBytes) { + setError(db, jmap, blobId, 'overLimit'); + continue; + } + let data: Uint8Array; + const type = nodeMediaType(JSON.parse(want.json) as WireNode); + try { + data = await ctx.transport.download(jmap, blobId, type, want.name); + } catch (error) { + // No network or no credentials reach the engine. One bad file doesn't stop the others. + if (error instanceof TransportError && error.kind === 'http') { + setError(db, jmap, blobId, 'download'); + continue; + } + throw error; + } + db.transaction(() => { + const now = wantedRow(db, jmap, blobId); + if (!now) return; + if (now.pinned ? pinnedBytes(db) + data.length > ctx.scope.maxTotalBytes : data.length > Math.min(ctx.scope.maxAttachmentBytes, capBytes(ctx))) { + // The size in the metadata was wrong or missing. With the real one + // noted, the next pass sees this without downloading it again. + db.run('UPDATE file_node SET size = ? WHERE jmap = ? AND blob_id = ?', [data.length, jmap, blobId]); + setError(db, jmap, blobId, now.pinned ? 'overLimit' : 'tooLarge'); + return; + } + if (!makeRoom(ctx, data.length, { pinned: Boolean(now.pinned), openedAt: Number(now.opened_at ?? 0) })) { + db.run('UPDATE file_node SET opened_at = NULL WHERE jmap = ? AND blob_id = ? AND pinned = 0', [jmap, blobId]); + return; + } + storeBlob(ctx, jmap, blobId, type, data); + setError(db, jmap, blobId, null); + }); + done += 1; + ctx.emit({ type: 'progress', account: ctx.account, area: 'files', phase: 'contents', done, total: todo.length }); + } + if (done > 0) ctx.emit({ type: 'changed', account: ctx.account, collections: ['FileContent'] }); +} + +// ---- Calls from the page ---- + +function fileRow(db: StorageAdapter, { jmap, id }: NodeRef): NodeRow { + const row = db.get('SELECT jmap, id, name, kind, blob_id, size, json, pinned, opened_at, keep_error FROM file_node WHERE jmap = ? AND id = ?', [jmap, id]); + if (!row) throw new MethodError('notFound', `No file ${id}`); + if (!row.blob_id || row.kind !== 'file') throw new MethodError('invalidArguments', 'Only files can be kept'); + return row; +} + +export function pinFile(ctx: StoreContext, ref: NodeRef): { kept: boolean } { + const row = fileRow(ctx.db, ref); + ctx.db.run('UPDATE file_node SET pinned = 1, keep_error = NULL WHERE jmap = ? AND id = ?', [ref.jmap, ref.id]); + const kept = hasBlob(ctx.db, ref.jmap, row.blob_id as string); + if (!kept) void ctx.requestSync(); + return { kept }; +} + +/** Back to being a recently opened file, or let go of it if it never was one. */ +export function unpinFile(ctx: StoreContext, ref: NodeRef): void { + const row = fileRow(ctx.db, ref); + ctx.db.transaction(() => { + ctx.db.run('UPDATE file_node SET pinned = 0 WHERE jmap = ? AND id = ?', [ref.jmap, ref.id]); + if (!wantedRow(ctx.db, ref.jmap, row.blob_id as string)) dropBlob(ctx.db, ref.jmap, row.blob_id as string); + }); +} + +export function noteOpened(ctx: StoreContext, ref: NodeRef): { kept: boolean } { + const row = fileRow(ctx.db, ref); + ctx.db.run('UPDATE file_node SET opened_at = ?, keep_error = NULL WHERE jmap = ? AND id = ?', [ctx.now(), ref.jmap, ref.id]); + const kept = hasBlob(ctx.db, ref.jmap, row.blob_id as string); + if (!kept) void ctx.requestSync(); + return { kept }; +} + +export function readFile(ctx: StoreContext, ref: NodeRef): (KeptFile & { name: string }) | null { + const row = fileRow(ctx.db, ref); + const kept = fileBlob(ctx, ref.jmap, row.blob_id as string); + return kept ? { ...kept, name: row.name } : null; +} + +export interface KeptFileStatus { + jmap: string; + id: string; + name: string; + size: number | null; + pinned: boolean; + openedAt: number | null; + kept: boolean; + /** Why it isn't kept: tooLarge, overLimit, notAllowed or download. */ + error: string | null; +} + +/** Pinned and recently opened files, and how much room their contents take. */ +export function keptStatus(ctx: StoreContext): { files: KeptFileStatus[]; bytes: number; capBytes: number } { + const rows = ctx.db.all( + `SELECT jmap, id, name, kind, blob_id, size, json, pinned, opened_at, keep_error FROM file_node + WHERE pinned = 1 OR opened_at IS NOT NULL ORDER BY pinned DESC, opened_at DESC, name`, + ); + return { + files: rows.map((row) => ({ + jmap: row.jmap, + id: row.id, + name: row.name, + size: row.size === null ? null : Number(row.size), + pinned: Boolean(row.pinned), + openedAt: row.opened_at === null ? null : Number(row.opened_at), + kept: row.blob_id !== null && hasBlob(ctx.db, row.jmap, row.blob_id), + error: row.keep_error, + })), + bytes: keptBlobs(ctx.db).reduce((sum, blob) => sum + Number(blob.size), 0), + capBytes: capBytes(ctx), + }; +} diff --git a/lib/store/files/methods.ts b/lib/store/files/methods.ts new file mode 100644 index 000000000..0945a33eb --- /dev/null +++ b/lib/store/files/methods.ts @@ -0,0 +1,108 @@ +/** + * FileNode reads answered from the store, so listings work offline. Nothing + * here answers FileNode/set: the responder gives it a per-call + * serverUnavailable, since the design has no offline file writes. + */ + +import { MethodError, type MethodContext, type MethodHandler, type MethodResult } from '../area'; +import type { SqlValue } from '../storage'; +import { FILES_CAPABILITY } from './records'; + +function jmapOf(ctx: MethodContext, args: Record): string { + return (args.accountId as string | undefined) ?? ctx.session.primaryAccounts[FILES_CAPABILITY] ?? ctx.defaultJmap; +} + +/** The last state from the server. Throws when the list was never read, so an empty answer always means empty. */ +function syncedState(ctx: MethodContext, jmap: string): string | null { + const row = ctx.db.get<{ state: string | null; phase: string | null }>("SELECT state, phase FROM sync_state WHERE jmap = ? AND type = 'FileNode'", [jmap]); + if (!row || (!row.state && !row.phase)) throw new MethodError('serverUnavailable', 'Files not kept yet'); + return row.state; +} + +function pick(node: Record, properties: unknown): Record { + if (!Array.isArray(properties)) return node; + const out: Record = { id: node.id }; + for (const property of properties as string[]) if (property in node) out[property] = node[property]; + return out; +} + +const SORTS: Record = { + name: 'name COLLATE NOCASE', + size: 'size', + created: "json_extract(json, '$.created')", + modified: "json_extract(json, '$.modified')", +}; + +function orderSql(sort: unknown): string { + const parts: string[] = []; + for (const level of (Array.isArray(sort) ? sort : []) as Array<{ property?: string; isAscending?: boolean }>) { + const column = SORTS[String(level.property)]; + if (!column) throw new MethodError('unsupportedSort', `${String(level.property)} isn't available offline`); + parts.push(`${column} ${level.isAscending === false ? 'DESC' : 'ASC'}`); + } + parts.push('name COLLATE NOCASE ASC', 'id ASC'); + return parts.join(', '); +} + +const fileNodeGet: MethodHandler = (ctx, args) => { + const jmap = jmapOf(ctx, args); + const state = syncedState(ctx, jmap); + const list: Array> = []; + const notFound: string[] = []; + if (Array.isArray(args.ids)) { + for (const id of args.ids as string[]) { + const row = ctx.db.get<{ json: string }>('SELECT json FROM file_node WHERE jmap = ? AND id = ?', [jmap, id]); + if (row) list.push(pick(JSON.parse(row.json) as Record, args.properties)); + else notFound.push(id); + } + } else { + // The whole tree at once. The client reads a long list as possibly cut, + // pages FileNode/query to check, and finds nothing missing. + for (const row of ctx.db.all<{ json: string }>('SELECT json FROM file_node WHERE jmap = ?', [jmap])) { + list.push(pick(JSON.parse(row.json) as Record, args.properties)); + } + } + return { accountId: jmap, ...(state ? { state } : {}), list, notFound }; +}; + +const fileNodeQuery: MethodHandler = (ctx, args) => { + const jmap = jmapOf(ctx, args); + syncedState(ctx, jmap); + if (args.anchor !== undefined) throw new MethodError('unsupportedFilter', 'anchor needs the server'); + const filter = (args.filter ?? {}) as Record; + const conditions = ['jmap = ?']; + const params: SqlValue[] = [jmap]; + for (const [key, value] of Object.entries(filter)) { + if (key !== 'parentId') throw new MethodError('unsupportedFilter', `${key} isn't available offline`); + if (value === null) { + conditions.push('parent_id IS NULL'); + } else { + conditions.push('parent_id = ?'); + params.push(String(value)); + } + } + const where = conditions.join(' AND '); + const position = Math.max(0, Number(args.position ?? 0)); + const limit = typeof args.limit === 'number' && args.limit > 0 ? args.limit : -1; + const ids = ctx.db.all<{ id: string }>( + `SELECT id FROM file_node WHERE ${where} ORDER BY ${orderSql(args.sort)} LIMIT ? OFFSET ?`, + [...params, limit, position], + ).map((row) => String(row.id)); + const result: MethodResult = { + accountId: jmap, + // Local answers aren't a position in the server's log, so this is a token only. + queryState: 'local', + canCalculateChanges: false, + position, + ids, + }; + if (args.calculateTotal) { + result.total = Number(ctx.db.get<{ n: number }>(`SELECT COUNT(*) AS n FROM file_node WHERE ${where}`, params)?.n ?? 0); + } + return result; +}; + +export const FILE_METHODS: Readonly> = { + 'FileNode/get': fileNodeGet, + 'FileNode/query': fileNodeQuery, +}; diff --git a/lib/store/files/records.ts b/lib/store/files/records.ts new file mode 100644 index 000000000..fd5cbcb51 --- /dev/null +++ b/lib/store/files/records.ts @@ -0,0 +1,50 @@ +/** How a FileNode becomes a row. The server's own copy stays in `json`, in whichever draft it speaks. */ + +import { fileNodeKind, fromDraftFileNode } from '@/lib/jmap/filenode-kind'; +import { decodeFileNodeName } from '@/lib/jmap/filenode-name'; +import type { FileNode } from '@/lib/jmap/types'; +import type { StorageAdapter } from '../storage'; + +export const FILES_CAPABILITY = 'urn:ietf:params:jmap:filenode'; +export const FILES_USING = ['urn:ietf:params:jmap:core', FILES_CAPABILITY]; + +/** The client's list (lib/jmap/client.ts). Stalwart leaves out shareWith and myRights unless asked. */ +export const FILE_NODE_PROPERTIES = [ + 'id', 'parentId', 'name', 'type', 'blobId', 'size', 'created', 'modified', + 'nodeType', '@type', 'mediaType', 'shareWith', 'myRights', +]; + +export type WireNode = Record & { id: string }; + +/** The node's media type, whichever draft named it. */ +export function nodeMediaType(node: WireNode): string { + const { type } = fromDraftFileNode(node as unknown as Partial & { '@type'?: unknown; mediaType?: unknown }); + return typeof type === 'string' && type ? type : 'application/octet-stream'; +} + +export function writeNode(db: StorageAdapter, jmap: string, node: WireNode, gen: number): void { + const normal = fromDraftFileNode(node as unknown as FileNode & { '@type'?: unknown; mediaType?: unknown }); + db.run( + `INSERT INTO file_node (jmap, id, parent_id, name, kind, blob_id, size, json, gen) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?) + ON CONFLICT (jmap, id) DO UPDATE SET parent_id = excluded.parent_id, name = excluded.name, kind = excluded.kind, + size = excluded.size, json = excluded.json, gen = excluded.gen, + keep_error = CASE WHEN blob_id IS excluded.blob_id THEN keep_error END, + blob_id = excluded.blob_id`, + [ + jmap, + node.id, + typeof node.parentId === 'string' ? node.parentId : null, + // The client decodes names itself from `json`. This column is for the store's own lists. + typeof node.name === 'string' ? decodeFileNodeName(node.name) : '', + fileNodeKind(normal), + typeof node.blobId === 'string' ? node.blobId : null, + typeof node.size === 'number' ? node.size : null, + JSON.stringify(node), + gen, + ], + ); +} + +export function removeNode(db: StorageAdapter, jmap: string, id: string): void { + db.run('DELETE FROM file_node WHERE jmap = ? AND id = ?', [jmap, id]); +} diff --git a/lib/store/files/schema.ts b/lib/store/files/schema.ts new file mode 100644 index 000000000..9a3f20e35 --- /dev/null +++ b/lib/store/files/schema.ts @@ -0,0 +1,47 @@ +import type { Migration } from '../storage'; + +export const FILE_MIGRATIONS: readonly Migration[] = [ + { + id: 700, + name: 'files', + sql: ` + CREATE TABLE file_node ( + jmap TEXT NOT NULL, + id TEXT NOT NULL, + parent_id TEXT, + name TEXT NOT NULL DEFAULT '', + -- file, directory or symlink, whichever way the server says so. + kind TEXT NOT NULL, + blob_id TEXT, + size INTEGER, + json TEXT NOT NULL, + gen INTEGER NOT NULL DEFAULT 0, + pinned INTEGER NOT NULL DEFAULT 0, + -- When the page last opened it. Cleared when its content is pushed out. + opened_at INTEGER, + -- Why the content isn't kept: tooLarge, overLimit, notAllowed or download. + keep_error TEXT, + PRIMARY KEY (jmap, id) + ) WITHOUT ROWID; + CREATE INDEX file_node_parent ON file_node (jmap, parent_id); + CREATE INDEX file_node_blob ON file_node (jmap, blob_id); + CREATE TABLE file_blob ( + jmap TEXT NOT NULL, + blob_id TEXT NOT NULL, + type TEXT NOT NULL, + size INTEGER NOT NULL, + kept_at INTEGER NOT NULL, + PRIMARY KEY (jmap, blob_id) + ) WITHOUT ROWID; + -- In pieces: a whole file bound at once would grow the WASM heap by its + -- size, and that memory never comes back. + CREATE TABLE file_blob_chunk ( + jmap TEXT NOT NULL, + blob_id TEXT NOT NULL, + seq INTEGER NOT NULL, + data BLOB NOT NULL, + PRIMARY KEY (jmap, blob_id, seq) + ); + `, + }, +]; diff --git a/lib/store/files/sync.ts b/lib/store/files/sync.ts new file mode 100644 index 000000000..cc9d99918 --- /dev/null +++ b/lib/store/files/sync.ts @@ -0,0 +1,160 @@ +/** + * FileNode metadata for one JMAP account, then the contents worth keeping. + * + * A full pass reads the tree the way the client does (fetchAllFileNodes, + * lib/jmap/client.ts). `FileNode/get` with ids null returns everything, but + * 0.16 silently stops at maxObjectsInGet and 1.0 refuses a larger account with + * requestTooLarge. Past that, ids come from paging FileNode/query. Before + * 0.16.6 that query leaves out folders, so parents still unknown afterwards are + * read by id. The cursor is in sync_state, so a reload continues. + */ + +import type { SyncContext, Syncer } from '../area'; +import { runChangesLoop } from '../engine/changes'; +import { JmapMethodError, responseFor, type MethodCall } from '../engine/transport'; +import { dropOrphanBlobs, fetchKeptFiles } from './keep'; +import { FILE_NODE_PROPERTIES, FILES_CAPABILITY, FILES_USING, removeNode, writeNode, type WireNode } from './records'; + +const MAX_GET = 500; +const GETS_PER_REQUEST = 8; +const QUERY_PAGE = 5000; + +function getBatch(ctx: SyncContext): number { + const core = ctx.session.capabilities['urn:ietf:params:jmap:core'] as { maxObjectsInGet?: number } | undefined; + return Math.min(MAX_GET, core?.maxObjectsInGet || MAX_GET); +} + +async function fetchNodes(ctx: SyncContext, jmap: string, ids: string[]): Promise { + const size = getBatch(ctx); + const nodes: WireNode[] = []; + for (let at = 0; at < ids.length;) { + const calls: MethodCall[] = []; + for (let i = 0; i < GETS_PER_REQUEST && at < ids.length; i += 1, at += size) { + calls.push(['FileNode/get', { accountId: jmap, ids: ids.slice(at, at + size), properties: FILE_NODE_PROPERTIES }, `g${i}`]); + } + const response = await ctx.transport.request(calls, FILES_USING); + calls.forEach(([, , callId]) => nodes.push(...responseFor(response, callId)[1].list as WireNode[])); + } + return nodes; +} + +interface ListCursor { step: 'all' | 'query' | 'parents'; position: number; gen: number; captured: string } + +async function startFullList(ctx: SyncContext, jmap: string): Promise { + const response = await ctx.transport.request([['FileNode/get', { accountId: jmap, ids: [], properties: ['id'] }, 's']], FILES_USING); + const captured = String(responseFor(response, 's')[1].state); + const gen = Number(ctx.db.get<{ gen: number | null }>('SELECT MAX(gen) AS gen FROM file_node WHERE jmap = ?', [jmap])?.gen ?? 0) + 1; + const cursor: ListCursor = { step: 'all', position: 0, gen, captured }; + ctx.db.transaction(() => ctx.setSyncState(jmap, 'FileNode', { state: null, phase: 'list', cursor: { ...cursor } })); + return cursor; +} + +function saveStep(ctx: SyncContext, jmap: string, nodes: WireNode[], cursor: ListCursor): void { + ctx.db.transaction(() => { + for (const node of nodes) writeNode(ctx.db, jmap, node, cursor.gen); + ctx.setSyncState(jmap, 'FileNode', { cursor: { ...cursor } }); + }); +} + +async function runFullList(ctx: SyncContext, jmap: string, start: ListCursor): Promise { + const cursor = { ...start }; + + if (cursor.step === 'all') { + let nodes: WireNode[] = []; + let complete = false; + try { + const response = await ctx.transport.request([['FileNode/get', { accountId: jmap, ids: null, properties: FILE_NODE_PROPERTIES }, 'a']], FILES_USING); + nodes = responseFor(response, 'a')[1].list as WireNode[]; + complete = nodes.length < getBatch(ctx); + } catch (error) { + if (!(error instanceof JmapMethodError && error.type === 'requestTooLarge')) throw error; + } + if (!complete) cursor.step = 'query'; + else cursor.step = 'parents'; + saveStep(ctx, jmap, nodes, cursor); + } + + while (cursor.step === 'query') { + if (ctx.stopped()) return false; + const response = await ctx.transport.request([['FileNode/query', { accountId: jmap, filter: {}, position: cursor.position, limit: QUERY_PAGE, calculateTotal: true }, 'q']], FILES_USING); + const [, query] = responseFor(response, 'q'); + const ids = query.ids as string[]; + const missing = ids.filter((id) => Number(ctx.db.get<{ gen: number }>('SELECT gen FROM file_node WHERE jmap = ? AND id = ?', [jmap, id])?.gen ?? -1) < cursor.gen); + const nodes = await fetchNodes(ctx, jmap, missing); + cursor.position += ids.length; + // The server may clamp the limit, so only an empty page or the total ends this. + if (ids.length === 0 || (typeof query.total === 'number' && cursor.position >= query.total)) cursor.step = 'parents'; + saveStep(ctx, jmap, nodes, cursor); + ctx.emit({ type: 'progress', account: ctx.account, area: 'files', phase: 'list', done: cursor.position, total: typeof query.total === 'number' ? query.total : null }); + } + + const asked = new Set(); + for (;;) { + if (ctx.stopped()) return false; + const parents = ctx.db.all<{ id: string }>( + `SELECT DISTINCT n.parent_id AS id FROM file_node n + WHERE n.jmap = ? AND n.gen = ? AND n.parent_id IS NOT NULL + AND NOT EXISTS (SELECT 1 FROM file_node p WHERE p.jmap = n.jmap AND p.id = n.parent_id AND p.gen = ?)`, + [jmap, cursor.gen, cursor.gen], + ).map((row) => String(row.id)).filter((id) => !asked.has(id)); + if (parents.length === 0) break; + for (const id of parents) asked.add(id); + saveStep(ctx, jmap, await fetchNodes(ctx, jmap, parents), cursor); + } + + ctx.db.transaction(() => { + // Whatever this pass didn't see is gone from the server. + ctx.db.run('DELETE FROM file_node WHERE jmap = ? AND gen < ?', [jmap, cursor.gen]); + ctx.setSyncState(jmap, 'FileNode', { state: cursor.captured, phase: null, cursor: null }); + }); + ctx.emit({ type: 'changed', account: ctx.account, collections: ['FileNode'] }); + return true; +} + +async function syncDelta(ctx: SyncContext, jmap: string, since: string, target: string | null): Promise<'done' | 'resync' | 'stopped'> { + const outcome = await runChangesLoop({ + transport: ctx.transport, + type: 'FileNode', + jmap, + using: FILES_USING, + since, + target, + stopped: ctx.stopped, + apply: async (page) => { + const nodes = await fetchNodes(ctx, jmap, [...page.created, ...page.updated]); + ctx.db.transaction(() => { + const gen = Number(ctx.db.get<{ gen: number | null }>('SELECT MAX(gen) AS gen FROM file_node WHERE jmap = ?', [jmap])?.gen ?? 0); + for (const node of nodes) writeNode(ctx.db, jmap, node, gen); + for (const id of page.destroyed) removeNode(ctx.db, jmap, id); + ctx.setSyncState(jmap, 'FileNode', { state: page.newState }); + }); + if (nodes.length + page.destroyed.length > 0) ctx.emit({ type: 'changed', account: ctx.account, collections: ['FileNode'] }); + }, + }); + if (outcome.outcome === 'resync') return 'resync'; + return outcome.outcome === 'stopped' ? 'stopped' : 'done'; +} + +export const filesSyncer: Syncer = { + name: 'files', + capability: FILES_CAPABILITY, + async run(ctx, jmap) { + const row = ctx.syncState(jmap, 'FileNode'); + let cursor = row.phase === 'list' ? row.cursor as unknown as ListCursor : null; + if (!cursor && !row.state) cursor = await startFullList(ctx, jmap); + if (!cursor && row.state) { + const outcome = await syncDelta(ctx, jmap, row.state, row.target); + if (outcome === 'stopped') return; + if (outcome === 'resync') cursor = await startFullList(ctx, jmap); + } + if (cursor) { + if (!(await runFullList(ctx, jmap, cursor))) return; + // Catch what changed while paging. + const after = ctx.syncState(jmap, 'FileNode'); + if (after.state && (await syncDelta(ctx, jmap, after.state, after.target)) === 'stopped') return; + } + if (ctx.stopped()) return; + ctx.db.transaction(() => dropOrphanBlobs(ctx.db)); + await fetchKeptFiles(ctx, jmap); + }, +}; From 64434bd5a6e7f3e22692ccf5a4c3443c1d016979 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 05:47:40 +0100 Subject: [PATCH 04/20] fix: keep the file list when refreshing a folder fails --- stores/__tests__/file-store.test.ts | 16 ++++++++++++++++ stores/file-store.ts | 4 +++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/stores/__tests__/file-store.test.ts b/stores/__tests__/file-store.test.ts index 6cb46aab6..bf7080b02 100644 --- a/stores/__tests__/file-store.test.ts +++ b/stores/__tests__/file-store.test.ts @@ -120,6 +120,22 @@ describe('file-store hierarchy (issue #379)', () => { }); }); + it('keeps the listing when refreshing the same folder fails, and starts empty in a new one', async () => { + const client = makeMockClient([dir('stuff', 'Stuff', null), file('notes', 'Notes.md', null), file('inner', 'Inner.md', 'stuff')]); + useFileStore.getState().initClient(client); + await useFileStore.getState().navigate(null); + expect(useFileStore.getState().resources.map(r => r.name).sort()).toEqual(['Notes.md', 'Stuff']); + + client.listAllFileNodes = async () => { throw new Error('offline'); }; + await useFileStore.getState().navigate(null); + expect(useFileStore.getState().error).toBe('offline'); + expect(useFileStore.getState().resources.map(r => r.name).sort()).toEqual(['Notes.md', 'Stuff']); + + await useFileStore.getState().navigate('stuff', 'Stuff'); + expect(useFileStore.getState().error).toBe('offline'); + expect(useFileStore.getState().resources).toEqual([]); + }); + it('lists only root-level nodes at the root, not the whole tree flattened', async () => { // Stuff > Nonsense > Notes.md / Other.md (the exact shape from the issue) const client = makeMockClient([ diff --git a/stores/file-store.ts b/stores/file-store.ts index f9ec1a6b5..3feada71e 100644 --- a/stores/file-store.ts +++ b/stores/file-store.ts @@ -982,7 +982,9 @@ export const useFileStore = create((set, get) => ({ error: error instanceof Error ? error.message : 'Failed to list directory', hasListed: true, isLoading: false, - resources: [], + // A refresh that fails keeps what the folder showed. Another folder's + // rows would be wrong here, so one being opened starts empty. + resources: opensFolder ? [] : get().resources, }); } }, From 691deff583e4ddf7c39a15dcec516c4f04e3cb58 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 05:50:58 +0100 Subject: [PATCH 05/20] fix: refuse a queued contact too large to ever send --- lib/store/__tests__/contacts.test.ts | 13 +++++++++++++ lib/store/contacts/pending.ts | 21 ++++++++++++++------- 2 files changed, 27 insertions(+), 7 deletions(-) diff --git a/lib/store/__tests__/contacts.test.ts b/lib/store/__tests__/contacts.test.ts index 526595a85..2331572e2 100644 --- a/lib/store/__tests__/contacts.test.ts +++ b/lib/store/__tests__/contacts.test.ts @@ -470,6 +470,19 @@ describe('queued edits', () => { expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); }); + it('refuses a card too large to ever send, so it cannot hold up the rest', async () => { + const server = new FakeContacts(); + const card = server.addCard(); + const { engine } = await synced(server); + const photo = { p: { kind: 'photo', uri: `data:image/jpeg;base64,${'A'.repeat(9 * 1024 * 1024)}` } }; + const made = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Big' }, addressBookIds: { book1: true }, media: photo } } }); + expect(made.notCreated.n.type).toBe('tooLarge'); + const edited = await call(engine, 'ContactCard/set', { update: { [card.id]: { media: photo } } }); + expect(edited.notUpdated[card.id].type).toBe('tooLarge'); + expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); + expect((await call(engine, 'ContactCard/get', { ids: [card.id] })).list[0]).not.toHaveProperty('media'); + }); + it('answers a patch that leads nowhere per record', async () => { const server = new FakeContacts(); const card = server.addCard(); diff --git a/lib/store/contacts/pending.ts b/lib/store/contacts/pending.ts index aaadc64b7..4cf2feba2 100644 --- a/lib/store/contacts/pending.ts +++ b/lib/store/contacts/pending.ts @@ -27,6 +27,8 @@ const LOCAL_BLOB_MARK = '"blobId":"bulwark-local-'; const SET_BATCH = 100; const SET_BATCH_BYTES = 5 * 1024 * 1024; +/** The server takes 10 MB a request. A bigger card would hold up everything queued behind it, for good. */ +const MAX_RECORD_BYTES = 8 * 1024 * 1024; const GET_BATCH = 500; const CALLS_PER_REQUEST = 16; /** Set errors that say nothing about the edit itself: it goes out again next time. */ @@ -86,6 +88,8 @@ function holdsLocalBlob(value: unknown): boolean { return JSON.stringify(value).includes(LOCAL_BLOB_MARK); } +const TOO_LARGE_ERROR: SetError = { type: 'tooLarge', description: 'This contact is too large to save' }; + const LOCAL_BLOB_ERROR: SetError = { type: 'invalidProperties', description: 'A photo that is not on the server yet cannot be used here', @@ -100,9 +104,10 @@ export function queueCreate(ctx: StoreContext, jmap: string, card: JsonObject): } const id = `${STAND_IN_PREFIX}${crypto.randomUUID()}`; const uid = typeof card.uid === 'string' && card.uid ? card.uid : `urn:uuid:${crypto.randomUUID()}`; - const payload = { ...card, uid }; - savePending(ctx.db, ctx, { jmap, id, op: 'create', uid, payload: JSON.stringify(payload), base: null }); - writeCard(ctx.db, jmap, { '@type': 'Card', version: '1.0', ...payload, id }); + const payload = JSON.stringify({ ...card, uid }); + if (payload.length > MAX_RECORD_BYTES) return TOO_LARGE_ERROR; + savePending(ctx.db, ctx, { jmap, id, op: 'create', uid, payload, base: null }); + writeCard(ctx.db, jmap, { '@type': 'Card', version: '1.0', ...card, uid, id }); return { id, uid }; } @@ -121,11 +126,13 @@ export function queueUpdate(ctx: StoreContext, jmap: string, rawId: string, patc throw error; } if (pending?.op === 'create') { - const payload = applyPatch(JSON.parse(pending.payload as string) as JsonObject, patch); - savePending(ctx.db, ctx, { jmap, id, op: 'create', uid: pending.uid, payload: JSON.stringify(payload), base: null }); + const payload = JSON.stringify(applyPatch(JSON.parse(pending.payload as string) as JsonObject, patch)); + if (payload.length > MAX_RECORD_BYTES) return TOO_LARGE_ERROR; + savePending(ctx.db, ctx, { jmap, id, op: 'create', uid: pending.uid, payload, base: null }); } else { - const merged = pending ? mergePatches(JSON.parse(pending.payload as string) as Patch, patch) : patch; - savePending(ctx.db, ctx, { jmap, id, op: 'update', payload: JSON.stringify(merged), base: pending ? pending.base : JSON.stringify(card) }); + const merged = JSON.stringify(pending ? mergePatches(JSON.parse(pending.payload as string) as Patch, patch) : patch); + if (merged.length > MAX_RECORD_BYTES) return TOO_LARGE_ERROR; + savePending(ctx.db, ctx, { jmap, id, op: 'update', payload: merged, base: pending ? pending.base : JSON.stringify(card) }); } writeCard(ctx.db, jmap, visible); return null; From 9fbe33004bf71f5f10dcf57e4ca989b6956a4efe Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 06:20:39 +0100 Subject: [PATCH 06/20] fix: send contact edits that remove entries and stop reading own edits as conflicts An edit that removed an entry was dropped at flush, because a server value with more keys counted as already applied. Other fixes in the same path: - the local copy after a flush is the server's read-back, never what was sent, since Stalwart 1.0 stores a data: URI as a blob - a delete or a newer edit after a lost response no longer reads as a change on the server, and an edit made during a refused send stays - a create only becomes a card with its uid if that card holds what was sent, otherwise it is a refused conflict - a refused or failed flush no longer stops contacts syncing - request limits come from the session - answers wait for the first full pass - paging goes by anchor, so a deleted card doesn't make the next one get skipped and swept contacts.test.ts: "continues a stopped full sync" now checks the anchor instead of position 2000, because the cursor no longer pages by position. --- lib/store/__tests__/contacts.test.ts | 392 ++++++++++++++++++- lib/store/__tests__/helpers/fake-contacts.ts | 51 ++- lib/store/contacts/methods.ts | 8 +- lib/store/contacts/patch.ts | 35 +- lib/store/contacts/pending.ts | 353 +++++++++++------ lib/store/contacts/schema.ts | 2 + lib/store/contacts/sync.ts | 83 ++-- lib/store/engine/limits.ts | 31 ++ 8 files changed, 788 insertions(+), 167 deletions(-) create mode 100644 lib/store/engine/limits.ts diff --git a/lib/store/__tests__/contacts.test.ts b/lib/store/__tests__/contacts.test.ts index 2331572e2..c05334fab 100644 --- a/lib/store/__tests__/contacts.test.ts +++ b/lib/store/__tests__/contacts.test.ts @@ -6,19 +6,19 @@ import path from 'node:path'; import { textFilter } from '@/lib/jmap/search-utils'; import { DEFAULT_SCOPE, type StoreEvent } from '../area'; import { contactsArea } from '../contacts'; -import { applyPatch, mergePatches } from '../contacts/patch'; +import { applyPatch, coversJson, mergePatches, sameJson } from '../contacts/patch'; import { AccountEngine } from '../engine/account-engine'; -import type { MethodCall } from '../engine/transport'; +import type { MethodCall, StoreSession } from '../engine/transport'; import type { StorageAdapter } from '../storage'; import { JMAP_ACCOUNT } from './helpers/fake-jmap'; import { CONTACTS_SESSION, FakeContacts, MAIL_ONLY_ACCOUNT, SHARED_ACCOUNT } from './helpers/fake-contacts'; import { openFileStore, openMemoryStore } from './helpers/node-adapter'; -function engineFor(server: FakeContacts, db: StorageAdapter = openMemoryStore(), emit?: (e: StoreEvent) => void) { +function engineFor(server: FakeContacts, db: StorageAdapter = openMemoryStore(), emit?: (e: StoreEvent) => void, session: StoreSession = CONTACTS_SESSION) { return new AccountEngine({ account: 'a@fake.test', db, - session: CONTACTS_SESSION, + session, transport: server, areas: [contactsArea], scope: DEFAULT_SCOPE, @@ -107,9 +107,11 @@ describe('contacts sync', () => { const second = openFileStore(file); await engineFor(server, second).requestSync(); expect(count(second, 'contact_card')).toBe(2600); - const positions = server.calls.filter(([name]) => name === 'ContactCard/query').map(([, args]) => args.position); - expect(positions[0]).toBe(2000); second.close(); + // It goes on from the last card read, not from the start. + const first_ = server.calls.find(([name]) => name === 'ContactCard/query')?.[1]; + expect(first_?.anchor).toBeTruthy(); + expect(first_?.anchorOffset).toBe(1); } finally { rmSync(dir, { recursive: true, force: true }); } @@ -670,4 +672,382 @@ describe('edits while sending', () => { expect(await engine.areaCall('contacts.pending', undefined)).toBe(0); }); }); + +const mine = (engine: AccountEngine, patch: Record, id: string) => call(engine, 'ContactCard/set', { update: { [id]: patch } }); +const conflictsOf = async (engine: AccountEngine) => await engine.areaCall('contacts.conflicts', undefined) as Array>; +const pendingOf = (engine: AccountEngine) => engine.areaCall('contacts.pending', undefined); + +describe('edits that make a card smaller', () => { + it.each<[string, Record, Record, Record]>([ + ['the last email', { emails: { e1: { address: 'a@example.org' } } }, { emails: {} }, { emails: {} }], + ['one of two emails', { emails: { e1: { address: 'a@example.org' }, e2: { address: 'b@example.org' } } }, { emails: { e1: { address: 'a@example.org' } } }, { emails: { e1: { address: 'a@example.org' } } }], + ['an email by pointer', { emails: { e1: { address: 'a@example.org' }, e2: { address: 'b@example.org' } } }, { 'emails/e2': null }, { emails: { e1: { address: 'a@example.org' } } }], + ['a keyword', { keywords: { work: true, home: true } }, { keywords: { work: true } }, { keywords: { work: true } }], + ['an address book', { addressBookIds: { book1: true, book2: true } }, { addressBookIds: { book2: true } }, { addressBookIds: { book2: true } }], + ['a group member', { kind: 'group', members: { 'urn:uuid:a': true, 'urn:uuid:b': true } }, { members: { 'urn:uuid:a': true } }, { members: { 'urn:uuid:a': true } }], + ])('sends the removal of %s', async (_label, start, patch, expected) => { + const server = new FakeContacts(['book1', 'book2']); + const card = server.addCard(start); + const { engine } = await synced(server); + await mine(engine, patch, card.id); + await engine.requestSync(); + expect(server.account().cards.get(card.id)).toMatchObject(expected); + for (const [key, value] of Object.entries(expected)) expect(server.account().cards.get(card.id)?.[key]).toEqual(value); + expect(await conflictsOf(engine)).toEqual([]); + expect(await pendingOf(engine)).toBe(0); + }); + + it('reads a key only the server has as its own, and one it had before as not yet removed', () => { + const wanted = { e1: { address: 'a' } }; + expect(coversJson(wanted, { e1: { address: 'a' }, added: { address: 'x' } }, { e1: { address: 'a' } })).toBe(true); + expect(coversJson(wanted, { e1: { address: 'a' }, e2: { address: 'b' } }, { e1: { address: 'a' }, e2: { address: 'b' } })).toBe(false); + expect(coversJson({ e: { '@type': 'x' } }, { e: { '@type': 'x', extra: 1 } }, undefined)).toBe(true); + // Stalwart 1.0 keeps a data: URI as a blob. + expect(coversJson({ m: { kind: 'photo', uri: 'data:image/png;base64,AA' } }, { m: { kind: 'photo', blobId: 'b1' } }, undefined)).toBe(true); + expect(coversJson({ m: { kind: 'logo', uri: 'data:image/png;base64,AA' } }, { m: { kind: 'photo', blobId: 'b1' } }, undefined)).toBe(false); + expect(sameJson({}, undefined)).toBe(true); + }); +}); + +describe('flush failures', () => { + it('still syncs after the server refuses the set as a whole, and records the edits', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'server' }); + const { engine } = await synced(server); + await mine(engine, { note: 'mine' }, card.id); + await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'New' }, addressBookIds: { book1: true } } } }); + server.failSet = () => ({ jmapError: 'forbidden' }); + server.addCard({ name: { full: 'From the server' } }); + await engine.requestSync(); + expect(await search(engine, 'from the server')).toEqual(['From the server']); + expect((await conflictsOf(engine)).map((c) => c.kind)).toEqual(['refused', 'refused']); + expect(await pendingOf(engine)).toBe(0); + expect((await call(engine, 'ContactCard/get', { ids: [card.id] })).list[0].note).toBe('server'); + }); + + it('keeps edits and still syncs when the failure says nothing about them', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'server' }); + const { engine } = await synced(server); + await mine(engine, { note: 'mine' }, card.id); + server.failSet = () => ({ jmapError: 'serverFail' }); + server.addCard({ name: { full: 'From the server' } }); + await engine.requestSync(); + expect(await search(engine, 'from the server')).toEqual(['From the server']); + expect(await conflictsOf(engine)).toEqual([]); + expect(await pendingOf(engine)).toBe(1); + server.failSet = null; + await engine.requestSync(); + expect(server.account().cards.get(card.id)?.note).toBe('mine'); + }); + + it('takes the rest of a batch through when one card makes the request fail', async () => { + const server = new FakeContacts(); + const good = server.addCard({ note: 'a' }); + const bad = server.addCard({ note: 'b' }); + const { engine } = await synced(server); + await mine(engine, { note: 'good edit' }, good.id); + await mine(engine, { note: 'poison' }, bad.id); + server.failSet = (args) => (JSON.stringify(args).includes('poison') ? { http: 400 } : null); + await engine.requestSync(); + expect(server.account().cards.get(good.id)?.note).toBe('good edit'); + expect(server.account().cards.get(bad.id)?.note).toBe('b'); + const conflicts = await conflictsOf(engine); + expect(conflicts.map((c) => [c.recordId, c.kind])).toEqual([[bad.id, 'refused']]); + expect(await pendingOf(engine)).toBe(0); + }); + + it('takes the request limit from the session', async () => { + const server = new FakeContacts(); + const card = server.addCard(); + const session = { ...CONTACTS_SESSION, capabilities: { ...CONTACTS_SESSION.capabilities, 'urn:ietf:params:jmap:core': { maxSizeRequest: 1000 } } }; + const db = openMemoryStore(); + const engine = engineFor(server, db, undefined, session); + await engine.requestSync(); + const result = await mine(engine, { note: 'x'.repeat(2000) }, card.id); + expect(result.notUpdated[card.id].type).toBe('tooLarge'); + }); +}); + +describe('a uid another card has', () => { + it('does not turn an offline create into that card', async () => { + const server = new FakeContacts(); + const other = server.addCard({ uid: 'urn:uuid:taken', name: { full: 'Their card' } }); + const { db, engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { uid: 'urn:uuid:taken', name: { full: 'My card' }, addressBookIds: { book1: true } } } }); + await engine.requestSync(); + const conflicts = await conflictsOf(engine); + expect(conflicts).toHaveLength(1); + expect(conflicts[0]).toMatchObject({ kind: 'refused', recordId: created.n.id, summary: 'My card', local: { op: 'create', payload: { name: { full: 'My card' } } } }); + expect((await call(engine, 'ContactCard/get', { ids: [created.n.id] })).notFound).toEqual([created.n.id]); + expect(db.all('SELECT id FROM contact_card').map((r) => r.id)).toEqual([other.id]); + expect(server.account().cards.get(other.id)).toMatchObject({ name: { full: 'Their card' } }); + }); + + it('does not take someone else\'s card for its own after a failed attempt either', async () => { + const server = new FakeContacts(); + const { engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { uid: 'urn:uuid:race', name: { full: 'Mine' }, addressBookIds: { book1: true } } } }); + server.offlineBeforeSet = true; + await engine.requestSync(); + const other = server.addCard({ uid: 'urn:uuid:race', name: { full: 'Theirs' } }); + await engine.requestSync(); + expect((await conflictsOf(engine)).map((c) => [c.recordId, c.kind])).toEqual([[created.n.id, 'refused']]); + expect(server.account().cards.size).toBe(1); + expect(server.account().cards.get(other.id)).toMatchObject({ name: { full: 'Theirs' } }); + }); + + it('does not delete someone else\'s card when the create was deleted again', async () => { + const server = new FakeContacts(); + const { engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { uid: 'urn:uuid:race', name: { full: 'Mine' }, addressBookIds: { book1: true } } } }); + server.offlineBeforeSet = true; + await engine.requestSync(); + await call(engine, 'ContactCard/set', { destroy: [created.n.id] }); + const other = server.addCard({ uid: 'urn:uuid:race', name: { full: 'Theirs' } }); + await engine.requestSync(); + expect(server.account().cards.has(other.id)).toBe(true); + expect(await pendingOf(engine)).toBe(0); + }); +}); + +describe('what the server really stored', () => { + const photo = { p: { kind: 'photo', uri: 'data:image/png;base64,iVBORw0KGgo=', mediaType: 'image/png' } }; + + it('does not read its own stored photo as a change after the network went, on 1.0', async () => { + const server = new FakeContacts(); + server.mediaAsBlobs = true; + const { engine } = await synced(server); + const { created } = await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Foto' }, addressBookIds: { book1: true }, media: photo } } }); + server.offlineAfterSet = true; + await engine.requestSync(); + expect(server.account().cards.size).toBe(1); + server.offline = false; + await call(engine, 'ContactCard/set', { destroy: [created.n.id] }); + await engine.requestSync(); + expect(await conflictsOf(engine)).toEqual([]); + expect(server.account().cards.size).toBe(0); + }); + + it('adopts its own card by uid though the server keeps the photo as a blob', async () => { + const server = new FakeContacts(); + server.mediaAsBlobs = true; + const { engine } = await synced(server); + await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Foto' }, addressBookIds: { book1: true }, media: photo } } }); + server.loseNextSet = true; + await engine.requestSync(); + await engine.requestSync(); + expect(await conflictsOf(engine)).toEqual([]); + expect(await pendingOf(engine)).toBe(0); + expect(server.account().cards.size).toBe(1); + }); + + it('keeps the card as the server read it back, not as it was sent, before any delta', async () => { + const server = new FakeContacts(); + server.mediaAsBlobs = true; + const { db, engine } = await synced(server); + await call(engine, 'ContactCard/set', { create: { n: { name: { full: 'Foto' }, addressBookIds: { book1: true }, media: photo } } }); + // The network goes right after the read-back, before the delta of this pass. + server.beforeRequest = () => { + const set = server.calls.findIndex(([name]) => name === 'ContactCard/set'); + if (set >= 0 && server.calls.slice(set).some(([name]) => name === 'ContactCard/get')) server.offline = true; + }; + await engine.requestSync(); + server.beforeRequest = null; + server.offline = false; + const row = db.get<{ json: string }>('SELECT json FROM contact_card'); + expect((JSON.parse(row?.json as string) as { media: Record }).media.p).toHaveProperty('blobId'); + const id = [...server.account().cards.keys()][0]; + await mine(engine, { note: 'after' }, id); + await engine.requestSync(); + expect(await conflictsOf(engine)).toEqual([]); + expect(server.account().cards.get(id)?.note).toBe('after'); + }); + + it('does not take a lost photo update for someone else changing it, on 1.0', async () => { + const server = new FakeContacts(); + server.mediaAsBlobs = true; + const card = server.addCard({ note: 'old' }); + const { engine } = await synced(server); + await mine(engine, { media: photo }, card.id); + server.loseNextSet = true; + await engine.requestSync(); + await engine.requestSync(); + expect(await conflictsOf(engine)).toEqual([]); + expect(await pendingOf(engine)).toBe(0); + }); +}); + +describe('after a lost update', () => { + it('still deletes the card', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old' }); + const { engine } = await synced(server); + await mine(engine, { note: 'mine' }, card.id); + server.loseNextSet = true; + await engine.requestSync(); + await call(engine, 'ContactCard/set', { destroy: [card.id] }); + await engine.requestSync(); + expect(await conflictsOf(engine)).toEqual([]); + expect(server.account().cards.has(card.id)).toBe(false); + }); + + it('does not delete when someone else changed another property too', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old', name: { full: 'A' } }); + const { engine } = await synced(server); + await mine(engine, { note: 'mine' }, card.id); + server.loseNextSet = true; + await engine.requestSync(); + await call(engine, 'ContactCard/set', { destroy: [card.id] }); + server.editCard(card.id, { name: { full: 'B' } }); + await engine.requestSync(); + expect(server.account().cards.has(card.id)).toBe(true); + expect((await conflictsOf(engine)).map((c) => c.kind)).toEqual(['changed']); + }); + + it('sends a newer edit of the same property', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old' }); + const { engine } = await synced(server); + await mine(engine, { note: 'first' }, card.id); + server.loseNextSet = true; + await engine.requestSync(); + await mine(engine, { note: 'second' }, card.id); + await engine.requestSync(); + expect(await conflictsOf(engine)).toEqual([]); + expect(server.account().cards.get(card.id)?.note).toBe('second'); + }); +}); + +describe('a refusal while the page kept editing', () => { + it('keeps the newer edit, and only records a conflict if it is refused too', async () => { + const server = new FakeContacts(); + const card = server.addCard({ note: 'old', name: { full: 'A' } }); + const { engine } = await synced(server); + await mine(engine, { note: 'one' }, card.id); + server.refuse.set(card.id, { type: 'forbidden' }); + const original = server.request.bind(server); + let edited = false; + server.request = async (calls: MethodCall[]) => { + if (!edited && calls.some(([name]) => name === 'ContactCard/set')) { + edited = true; + await mine(engine, { 'name/full': 'B' }, card.id); + } + return original(calls); + }; + await engine.requestSync(); + expect(await pendingOf(engine)).toBe(1); + expect(await conflictsOf(engine)).toEqual([]); + server.refuse.clear(); + await engine.requestSync(); + expect(server.account().cards.get(card.id)).toMatchObject({ note: 'one', name: { full: 'B' } }); + expect(await pendingOf(engine)).toBe(0); + }); +}); + +describe('session limits', () => { + it('takes maxObjectsInGet and maxCallsInRequest from the session', async () => { + const server = new FakeContacts(); + server.maxObjectsInGet = 2; + const cards = [server.addCard(), server.addCard(), server.addCard(), server.addCard(), server.addCard()]; + const session = { ...CONTACTS_SESSION, capabilities: { ...CONTACTS_SESSION.capabilities, 'urn:ietf:params:jmap:core': { maxObjectsInGet: 2, maxCallsInRequest: 4 } } }; + const db = openMemoryStore(); + const events: StoreEvent[] = []; + const engine = engineFor(server, db, (e) => events.push(e), session); + await engine.requestSync(); + expect(events.filter((e) => e.type === 'error')).toEqual([]); + expect(count(db, 'contact_card')).toBe(5); + for (const [name, args] of server.calls) { + if (name === 'ContactCard/query') expect(args.limit).toBeLessThanOrEqual(2); + } + for (const card of cards.slice(0, 3)) await mine(engine, { note: 'x' }, card.id); + await engine.requestSync(); + expect(events.filter((e) => e.type === 'error')).toEqual([]); + expect(await pendingOf(engine)).toBe(0); + expect(cards.slice(0, 3).map((c) => server.account().cards.get(c.id)?.note)).toEqual(['x', 'x', 'x']); + }); +}); + +describe('an interrupted first sync', () => { + it('answers serverUnavailable until the first full pass is done', async () => { + const server = new FakeContacts(); + for (let i = 0; i < 2600; i += 1) server.addCard(); + const db = openMemoryStore(); + const engine = engineFor(server, db); + let requests = 0; + server.beforeRequest = () => { + requests += 1; + if (requests === 4) server.offline = true; + }; + await engine.requestSync(); + expect(count(db, 'contact_card')).toBe(2000); + expect(await engine.answer([['ContactCard/query', { accountId: JMAP_ACCOUNT, limit: 50 }, '0']])).toBeNull(); + expect(await engine.answer([['ContactCard/get', { accountId: JMAP_ACCOUNT, ids: null }, '0']])).toBeNull(); + server.offline = false; + server.beforeRequest = null; + await engine.requestSync(); + expect((await call(engine, 'ContactCard/query', { calculateTotal: true })).total).toBe(2600); + }); + + it('goes on answering from the old copy while a later resync runs', async () => { + const server = new FakeContacts(); + for (let i = 0; i < 2600; i += 1) server.addCard(); + const { db, engine } = await synced(server); + db.run("UPDATE sync_state SET state = 'bad state!' WHERE type = 'ContactCard'"); + let requests = 0; + server.beforeRequest = () => { + requests += 1; + if (requests === 3) server.offline = true; + }; + await engine.requestSync(); + expect((await call(engine, 'ContactCard/query', { calculateTotal: true })).total).toBe(2600); + }); +}); + +describe('paging while cards change', () => { + it('does not skip a card when an earlier one is deleted between requests', async () => { + const server = new FakeContacts(); + const cards = Array.from({ length: 2600 }, () => server.addCard()); + const db = openMemoryStore(); + const engine = engineFor(server, db); + let queries = 0; + const original = server.request.bind(server); + server.request = async (calls: MethodCall[]) => { + if (calls.some(([name]) => name === 'ContactCard/query')) { + queries += 1; + if (queries === 2) server.removeCard(cards[0].id); + } + return original(calls); + }; + await engine.requestSync(); + const kept = new Set(db.all<{ id: string }>('SELECT id FROM contact_card').map((r) => r.id)); + expect(cards.slice(1).filter((c) => !kept.has(c.id))).toEqual([]); + expect(kept.has(cards[0].id)).toBe(false); + const anchored = server.calls.filter(([name, args]) => name === 'ContactCard/query' && args.anchor !== undefined); + expect(anchored.length).toBeGreaterThan(0); + }); + + it('starts over when the card it paged from is gone', async () => { + const server = new FakeContacts(); + const cards = Array.from({ length: 2600 }, () => server.addCard()); + const db = openMemoryStore(); + const engine = engineFor(server, db); + let queries = 0; + const original = server.request.bind(server); + server.request = async (calls: MethodCall[]) => { + if (calls.some(([name]) => name === 'ContactCard/query')) { + queries += 1; + if (queries === 2) server.removeCard(cards[1999].id); + } + return original(calls); + }; + const events: StoreEvent[] = []; + await engine.requestSync(); + expect(events).toEqual([]); + const kept = new Set(db.all<{ id: string }>('SELECT id FROM contact_card').map((r) => r.id)); + expect(kept.size).toBe(2599); + expect(kept.has(cards[1999].id)).toBe(false); + }); +}); /* eslint-enable @typescript-eslint/no-explicit-any */ diff --git a/lib/store/__tests__/helpers/fake-contacts.ts b/lib/store/__tests__/helpers/fake-contacts.ts index e6b408755..6cec59cbf 100644 --- a/lib/store/__tests__/helpers/fake-contacts.ts +++ b/lib/store/__tests__/helpers/fake-contacts.ts @@ -37,6 +37,15 @@ export function changesFor(coll: Collection, args: Record): Rec return { accountId: args.accountId, oldState: since, ...coll.changes(since, maxChanges) }; } +function storedMedia(card: Obj): void { + const media = card.media as Record> | undefined; + for (const [key, entry] of Object.entries(media ?? {})) { + if (typeof entry.uri !== 'string' || !entry.uri.startsWith('data:')) continue; + const { uri, ...rest } = entry; + (media as Record)[key] = { ...rest, blobId: `stored-${uri.length}-${key}` }; + } +} + function applyServerPatch(card: Obj, patch: Record): void { for (const [path, value] of Object.entries(patch)) { const steps = path.split('/'); @@ -63,6 +72,16 @@ export class FakeContacts extends FakeJmap { readonly refuse = new Map(); /** A server that lets two cards have one uid, as nothing in the RFC forbids it. */ allowDuplicateUids = false; + /** Stalwart 1.0 stores a data: URI in `media` as a blob: `uri` goes, `blobId` comes (measured). */ + mediaAsBlobs = false; + /** Set to apply the next ContactCard/set, answer it, and then lose the network. */ + offlineAfterSet = false; + /** Set to lose the network before the next ContactCard/set reaches the server. */ + offlineBeforeSet = false; + /** The most ids ContactCard/get and calls a request take, as a session can say. */ + maxObjectsInGet = 500; + /** Answers a ContactCard/set call as a whole, instead of handling it. */ + failSet: ((args: Record) => { jmapError: string } | { http: number } | null) | null = null; constructor(books: string[] = ['book1']) { super(); @@ -131,7 +150,9 @@ export class FakeContacts extends FakeJmap { notCreated[cid] = { type: 'invalidProperties', description: `Contact with UID ${String(raw.uid)} already exists with id ${clash.id}.`, properties: ['uid'] }; } else { const id = `c${this.nextCard++}`; - account.cards.set(id, { '@type': 'Card', version: '1.0', ...raw, id }); + const stored: Obj = { '@type': 'Card', version: '1.0', ...structuredClone(raw), id }; + if (this.mediaAsBlobs) storedMedia(stored); + account.cards.set(id, stored); account.coll.ContactCard.push('created', id); created[cid] = { id }; } @@ -142,7 +163,8 @@ export class FakeContacts extends FakeJmap { if (refused) notUpdated[id] = refused; else if (!card) notUpdated[id] = { type: 'notFound' }; else { - applyServerPatch(card, patch); + applyServerPatch(card, structuredClone(patch)); + if (this.mediaAsBlobs) storedMedia(card); account.coll.ContactCard.push('updated', id); updated[id] = null; } @@ -187,7 +209,12 @@ export class FakeContacts extends FakeJmap { let list = [...account.cards.values()]; if (filter.uid) list = list.filter((c) => c.uid === filter.uid); if (filter.inAddressBook) list = list.filter((c) => (c.addressBookIds as Record)[filter.inAddressBook as string]); - const position = Number(args.position ?? 0); + let position = Number(args.position ?? 0); + if (args.anchor !== undefined) { + const at = list.findIndex((c) => c.id === args.anchor); + if (at < 0) throw Object.assign(new Error('anchorNotFound'), { jmapError: 'anchorNotFound' }); + position = at + Number(args.anchorOffset ?? 0); + } const limit = Number(args.limit ?? 5000) || 5000; return { accountId: args.accountId, @@ -200,8 +227,8 @@ export class FakeContacts extends FakeJmap { } case 'ContactCard/get': { const ids = args.ids as string[] | null | undefined; - if (ids && ids.length > 500) throw Object.assign(new Error('requestTooLarge'), { jmapError: 'requestTooLarge' }); - const chosen = ids ?? [...account.cards.keys()].slice(0, 500); + if (ids && ids.length > this.maxObjectsInGet) throw Object.assign(new Error('requestTooLarge'), { jmapError: 'requestTooLarge' }); + const chosen = ids ?? [...account.cards.keys()].slice(0, this.maxObjectsInGet); return { accountId: args.accountId, state: account.coll.ContactCard.state(), @@ -209,8 +236,12 @@ export class FakeContacts extends FakeJmap { notFound: chosen.filter((id) => !account.cards.has(id)), }; } - case 'ContactCard/set': + case 'ContactCard/set': { + const failure = this.failSet?.(args); + if (failure && 'http' in failure) throw new TransportError('http', `JMAP request failed: ${failure.http}`, failure.http, 'urn:ietf:params:jmap:error:limit'); + if (failure) throw Object.assign(new Error(failure.jmapError), failure); return this.contactSet(account, args); + } default: return super.handle(name, args); } @@ -219,7 +250,15 @@ export class FakeContacts extends FakeJmap { override async request(calls: MethodCall[], using?: string[]): Promise { // The real server fails the whole request for a capability it doesn't list. void using; + if (this.offlineBeforeSet && calls.some(([name]) => name === 'ContactCard/set')) { + this.offlineBeforeSet = false; + throw new TransportError('network', 'Failed to fetch'); + } const response = await super.request(calls); + if (this.offlineAfterSet && calls.some(([name]) => name === 'ContactCard/set')) { + this.offlineAfterSet = false; + this.offline = true; + } if (this.loseNextSet && calls.some(([name]) => name === 'ContactCard/set')) { this.loseNextSet = false; throw new TransportError('network', 'Connection dropped after the server took the request'); diff --git a/lib/store/contacts/methods.ts b/lib/store/contacts/methods.ts index f3c885909..9ef5a391f 100644 --- a/lib/store/contacts/methods.ts +++ b/lib/store/contacts/methods.ts @@ -15,10 +15,14 @@ function jmapOf(ctx: MethodContext, args: Record): string { return (args.accountId as string | undefined) ?? ctx.session.primaryAccounts[CONTACTS_CAPABILITY] ?? ctx.defaultJmap; } -/** The last state from the server. Throws when this type was never synced, so an empty answer always means empty. */ +/** + * The last state from the server. Throws until a first full pass finished, so + * an answer never passes off part of a list as the whole. A later resync + * (phase `list`) goes on answering from the copy it's refreshing. + */ function syncedState(ctx: MethodContext, jmap: string, type: string): string | null { const row = ctx.db.get<{ state: string | null; phase: string | null }>('SELECT state, phase FROM sync_state WHERE jmap = ? AND type = ?', [jmap, type]); - if (!row || (!row.state && !row.phase)) throw new MethodError('serverUnavailable', 'Contacts not kept yet'); + if (!row || (!row.state && row.phase !== 'list')) throw new MethodError('serverUnavailable', 'Contacts not kept yet'); return row.state; } diff --git a/lib/store/contacts/patch.ts b/lib/store/contacts/patch.ts index 07247b3d9..61a5c1050 100644 --- a/lib/store/contacts/patch.ts +++ b/lib/store/contacts/patch.ts @@ -67,9 +67,13 @@ export function touchedProperties(patch: Patch): string[] { return [...new Set(Object.keys(patch).map((path) => steps(path)[0]))]; } -/** Deep equality that ignores key order. Absent and null count as the same. */ +function isNothing(value: unknown): boolean { + return value == null || (isObject(value) && Object.keys(value).length === 0); +} + +/** Deep equality that ignores key order. Absent, null and an empty map count as the same. */ export function sameJson(a: unknown, b: unknown): boolean { - if (a === b || (a == null && b == null)) return true; + if (a === b || (isNothing(a) && isNothing(b))) return true; if (Array.isArray(a) && Array.isArray(b)) { return a.length === b.length && a.every((item, i) => sameJson(item, b[i])); } @@ -79,10 +83,27 @@ export function sameJson(a: unknown, b: unknown): boolean { return false; } -/** Whether `actual` holds everything in `wanted`. A server may add properties of its own. */ -export function coversJson(wanted: unknown, actual: unknown): boolean { - if (isObject(wanted) && isObject(actual)) { - return Object.keys(wanted).every((key) => coversJson(wanted[key], actual[key])); +/** Stalwart 1.0 keeps a data: URI in `media` as a blob: `uri` goes and `blobId` comes (measured). */ +function inlineKeptAsBlob(wanted: JsonObject, actual: JsonObject): boolean { + return typeof wanted.uri === 'string' && wanted.uri.startsWith('data:') && actual.uri == null && typeof actual.blobId === 'string'; +} + +/** + * Whether `actual` is `wanted` as far as a server can tell. A key only the + * server has is its own, unless `base` shows it was there before the edit: + * then the edit meant to remove it, and it hasn't happened yet. + */ +export function coversJson(wanted: unknown, actual: unknown, base?: unknown): boolean { + if (!isObject(wanted) || !isObject(actual)) return sameJson(wanted, actual); + const before = isObject(base) ? base : {}; + const inline = inlineKeptAsBlob(wanted, actual); + for (const key of Object.keys(wanted)) { + if (inline && key === 'uri') continue; + if (!coversJson(wanted[key], actual[key], before[key])) return false; } - return sameJson(wanted, actual); + for (const key of Object.keys(actual)) { + if (key in wanted || (inline && key === 'blobId')) continue; + if (before[key] != null) return false; + } + return true; } diff --git a/lib/store/contacts/pending.ts b/lib/store/contacts/pending.ts index 4cf2feba2..f6d2bdc78 100644 --- a/lib/store/contacts/pending.ts +++ b/lib/store/contacts/pending.ts @@ -12,11 +12,21 @@ * - Destroy: done if the card is gone, a conflict if it changed since. * - Create: a request that may have reached the server looks for the card's * uid first, so a lost response doesn't make a second card. Stalwart also - * refuses a second card with the same uid, which ends up the same way. + * refuses a second card with the same uid. Either way the card found is only + * ours if it holds what was sent, or an offline card with someone else's uid + * would silently turn into theirs. + * + * The local copy after sending is always the server's own read-back, never what + * was sent: Stalwart 1.0 stores a data: URI as a blob. A base built from what + * was sent would read that as someone else's change. If the network goes before + * the read-back, that counts as a lost response: the row stays, and the next + * pass finds its edit already there. `sent` is what the last request held, so + * the next pass can tell its own edit from someone else's. */ import type { StoreContext, SyncContext } from '../area'; -import { responseFor, type MethodCall } from '../engine/transport'; +import { requestLimits, type RequestLimits } from '../engine/limits'; +import { JmapMethodError, responseFor, TransportError, type MethodCall } from '../engine/transport'; import type { StorageAdapter } from '../storage'; import { applyPatch, coversJson, InvalidPatchError, mergePatches, sameJson, touchedProperties, type JsonObject, type Patch } from './patch'; import { cardDisplayName, CONTACTS_USING, readCard, removeCard, writeCard, type Card } from './records'; @@ -26,11 +36,12 @@ export const STAND_IN_PREFIX = 'bulwark-local-card-'; const LOCAL_BLOB_MARK = '"blobId":"bulwark-local-'; const SET_BATCH = 100; -const SET_BATCH_BYTES = 5 * 1024 * 1024; -/** The server takes 10 MB a request. A bigger card would hold up everything queued behind it, for good. */ -const MAX_RECORD_BYTES = 8 * 1024 * 1024; -const GET_BATCH = 500; -const CALLS_PER_REQUEST = 16; + +/** Of the session's request limit. A bigger card would never go out. */ +function maxRecordBytes(ctx: StoreContext): number { + return Math.floor(requestLimits(ctx.session).maxSizeRequest * 0.8); +} + /** Set errors that say nothing about the edit itself: it goes out again next time. */ const TRANSIENT_ERRORS = new Set(['serverFail', 'serverUnavailable', 'rateLimit']); /** Server-kept timestamps: their changing doesn't mean someone edited the card. */ @@ -45,6 +56,7 @@ export interface PendingRow { payload: string | null; base: string | null; attempted: number; + sent: string | null; queued_at: number; } @@ -105,7 +117,7 @@ export function queueCreate(ctx: StoreContext, jmap: string, card: JsonObject): const id = `${STAND_IN_PREFIX}${crypto.randomUUID()}`; const uid = typeof card.uid === 'string' && card.uid ? card.uid : `urn:uuid:${crypto.randomUUID()}`; const payload = JSON.stringify({ ...card, uid }); - if (payload.length > MAX_RECORD_BYTES) return TOO_LARGE_ERROR; + if (payload.length > maxRecordBytes(ctx)) return TOO_LARGE_ERROR; savePending(ctx.db, ctx, { jmap, id, op: 'create', uid, payload, base: null }); writeCard(ctx.db, jmap, { '@type': 'Card', version: '1.0', ...card, uid, id }); return { id, uid }; @@ -127,11 +139,11 @@ export function queueUpdate(ctx: StoreContext, jmap: string, rawId: string, patc } if (pending?.op === 'create') { const payload = JSON.stringify(applyPatch(JSON.parse(pending.payload as string) as JsonObject, patch)); - if (payload.length > MAX_RECORD_BYTES) return TOO_LARGE_ERROR; + if (payload.length > maxRecordBytes(ctx)) return TOO_LARGE_ERROR; savePending(ctx.db, ctx, { jmap, id, op: 'create', uid: pending.uid, payload, base: null }); } else { const merged = JSON.stringify(pending ? mergePatches(JSON.parse(pending.payload as string) as Patch, patch) : patch); - if (merged.length > MAX_RECORD_BYTES) return TOO_LARGE_ERROR; + if (merged.length > maxRecordBytes(ctx)) return TOO_LARGE_ERROR; savePending(ctx.db, ctx, { jmap, id, op: 'update', payload: merged, base: pending ? pending.base : JSON.stringify(card) }); } writeCard(ctx.db, jmap, visible); @@ -228,30 +240,44 @@ function withoutStamps(card: JsonObject): JsonObject { return copy; } -async function readServerCards(ctx: SyncContext, jmap: string, ids: string[]): Promise> { +async function readServerCards(ctx: SyncContext, jmap: string, ids: string[], limits: RequestLimits): Promise> { const cards = new Map(); - for (let i = 0; i < ids.length; i += GET_BATCH) { - const response = await ctx.transport.request([['ContactCard/get', { accountId: jmap, ids: ids.slice(i, i + GET_BATCH) }, 'g']], CONTACTS_USING); + for (let i = 0; i < ids.length; i += limits.maxObjectsInGet) { + const response = await ctx.transport.request([['ContactCard/get', { accountId: jmap, ids: ids.slice(i, i + limits.maxObjectsInGet) }, 'g']], CONTACTS_USING); for (const card of responseFor(response, 'g')[1].list as Card[]) cards.set(card.id, card); } return cards; } -/** The ids the server has for these uids. */ -async function lookUpUids(ctx: SyncContext, jmap: string, uids: string[]): Promise> { - const found = new Map(); - for (let i = 0; i < uids.length; i += CALLS_PER_REQUEST) { - const group = uids.slice(i, i + CALLS_PER_REQUEST); +/** The server's cards with these uids. */ +async function cardsByUid(ctx: SyncContext, jmap: string, uids: string[], limits: RequestLimits): Promise> { + const ids = new Map(); + for (let i = 0; i < uids.length; i += limits.maxCallsInRequest) { + const group = uids.slice(i, i + limits.maxCallsInRequest); const calls: MethodCall[] = group.map((uid, n) => ['ContactCard/query', { accountId: jmap, filter: { uid }, limit: 1 }, `q${n}`]); const response = await ctx.transport.request(calls, CONTACTS_USING); group.forEach((uid, n) => { - const ids = responseFor(response, `q${n}`)[1].ids as string[]; - if (ids.length > 0) found.set(uid, ids[0]); + const found = responseFor(response, `q${n}`)[1].ids as string[]; + if (found.length > 0) ids.set(uid, found[0]); }); } - return found; + const cards = await readServerCards(ctx, jmap, [...ids.values()], limits); + const byUid = new Map(); + for (const [uid, id] of ids) { + const card = cards.get(id); + if (card) byUid.set(uid, card); + } + return byUid; } +/** Whether a card the server has under our uid is the one we sent. */ +function holdsSent(sentPayload: string, card: Card): boolean { + const sent = JSON.parse(sentPayload) as JsonObject; + return Object.keys(sent).every((key) => coversJson(sent[key], card[key])); +} + +const UID_TAKEN: SetError = { type: 'invalidProperties', description: 'Another contact already has this uid', properties: ['uid'] }; + /** The create went through, or had already. The stand-in row becomes the server's card. */ function settleCreated(ctx: SyncContext, sent: PendingRow, server: Card): void { const { db } = ctx; @@ -282,29 +308,59 @@ function settleCreated(ctx: SyncContext, sent: PendingRow, server: Card): void { interface Decision { create: Map; update: Map; destroy: Map } +/** + * Whether someone else moved one of these properties since the edit was queued. + * The server holding what our last request sent is our own doing, not a change: + * its response may have been lost. + */ +function movedOnServer(row: PendingRow, server: Card, keys: readonly string[]): boolean { + if (!row.base) return false; + const base = JSON.parse(row.base) as JsonObject; + let own: JsonObject | null = null; + if (row.sent) { + try { + own = applyPatch(base, JSON.parse(row.sent) as Patch); + } catch (error) { + if (!(error instanceof InvalidPatchError)) throw error; + } + } + return keys.some((key) => !sameJson(base[key], server[key]) && !(own && coversJson(own[key], server[key], base[key]))); +} + /** What to do with one row now that the server's copy is known. Conflicts are settled here. */ function decide(ctx: SyncContext, row: PendingRow, server: Card | undefined, serverByUid: Map, out: Decision): void { const { db } = ctx; const { jmap, id } = row; const uidHit = row.uid ? serverByUid.get(row.uid) : undefined; if (row.op === 'create') { - if (uidHit) { - settleCreated(ctx, row, { ...(JSON.parse(row.payload as string) as JsonObject), ...uidHit }); - return; + if (!uidHit) { + out.create.set(id, row); + } else if (holdsSent(row.sent ?? (row.payload as string), uidHit)) { + settleCreated(ctx, { ...row, payload: row.sent ?? row.payload }, uidHit); + } else { + recordConflict(ctx, row, 'refused', null, UID_TAKEN); + dropPending(db, jmap, id); + removeCard(db, jmap, id); } - out.create.set(id, row); return; } if (row.op === 'destroy' && id.startsWith(STAND_IN_PREFIX)) { - // A create that may have gone out, deleted since. Without a card on the server, nothing to do. + // A create that may have gone out, deleted since. Only a card holding what was sent is ours to delete. dropPending(db, jmap, id); - if (uidHit) savePending(db, ctx, { jmap, id: uidHit.id, op: 'destroy', payload: null, base: JSON.stringify(uidHit) }); + const sent = row.sent ?? row.payload; + if (uidHit && sent && holdsSent(sent, uidHit)) { + savePending(db, ctx, { jmap, id: uidHit.id, op: 'destroy', payload: null, base: JSON.stringify(uidHit) }); + } return; } if (row.op === 'destroy') { if (!server) { dropPending(db, jmap, id); - } else if (row.base && !sameJson(withoutStamps(JSON.parse(row.base) as JsonObject), withoutStamps(server))) { + return; + } + const stable = withoutStamps(server); + const base = row.base ? withoutStamps(JSON.parse(row.base) as JsonObject) : {}; + if (movedOnServer(row, server, [...new Set([...Object.keys(stable), ...Object.keys(base)])])) { recordConflict(ctx, row, 'changed', server, null); dropPending(db, jmap, id); writeCard(db, jmap, server); @@ -320,7 +376,7 @@ function decide(ctx: SyncContext, row: PendingRow, server: Card | undefined, ser return; } const patch = JSON.parse(row.payload as string) as Patch; - const base = row.base ? JSON.parse(row.base) as JsonObject : null; + const base = row.base ? JSON.parse(row.base) as JsonObject : {}; let applied: Card | null = null; try { applied = applyPatch(server, patch); @@ -328,12 +384,12 @@ function decide(ctx: SyncContext, row: PendingRow, server: Card | undefined, ser if (!(error instanceof InvalidPatchError)) throw error; } const touched = touchedProperties(patch); - if (applied && touched.every((key) => coversJson((applied as Card)[key], server[key]))) { + if (applied && touched.every((key) => coversJson((applied as Card)[key], server[key], base[key]))) { dropPending(db, jmap, id); writeCard(db, jmap, server); return; } - if (!applied || (base && touched.some((key) => !sameJson(base[key], server[key])))) { + if (!applied || movedOnServer(row, server, touched)) { recordConflict(ctx, row, 'changed', server, null); dropPending(db, jmap, id); writeCard(db, jmap, server); @@ -342,125 +398,176 @@ function decide(ctx: SyncContext, row: PendingRow, server: Card | undefined, ser out.update.set(id, row); } -function settleUpdated(ctx: SyncContext, sent: PendingRow, server: Card): void { - const now = pendingFor(ctx.db, sent.jmap, sent.id); +function settleUpdated(ctx: SyncContext, sent: PendingRow, server: Card | undefined): void { + const { db } = ctx; + const now = pendingFor(db, sent.jmap, sent.id); if (!now) return; if (now.op === 'update' && now.payload === sent.payload) { - dropPending(ctx.db, sent.jmap, sent.id); + dropPending(db, sent.jmap, sent.id); + if (server) writeCard(db, sent.jmap, server); return; } - // Edited again while this was on its way: that edit now builds on what was sent. - const base = applyPatch(server, JSON.parse(sent.payload as string) as Patch); - ctx.db.run('UPDATE contact_pending SET base = ? WHERE seq = ?', [JSON.stringify(base), now.seq]); + // Edited again while this was on its way: that edit now builds on what the server holds. + if (!server) return; + db.run('UPDATE contact_pending SET base = ?, sent = NULL, attempted = 0 WHERE seq = ?', [JSON.stringify(server), now.seq]); + if (now.op === 'update') storeServerCard(db, sent.jmap, server); } -function settleRefused(ctx: SyncContext, row: PendingRow, error: SetError, server: Card | undefined): void { +function settleRefused(ctx: SyncContext, sent: PendingRow, error: SetError, server: Card | undefined): void { const { db } = ctx; if (TRANSIENT_ERRORS.has(error.type)) return; - if (row.op === 'destroy' && error.type === 'notFound') { - dropPending(db, row.jmap, row.id); + const now = pendingFor(db, sent.jmap, sent.id); + if (now && (now.op !== sent.op || now.payload !== sent.payload)) { + // Edited again while this was on its way, so the refused edit is still in + // the row. It goes out once more, and a second refusal is the conflict. + db.run('UPDATE contact_pending SET sent = NULL, attempted = 0 WHERE seq = ?', [now.seq]); + return; + } + if (sent.op === 'destroy' && error.type === 'notFound') { + dropPending(db, sent.jmap, sent.id); return; } const kind = error.type === 'notFound' ? 'gone' : 'refused'; - recordConflict(ctx, row, kind, server ?? null, error); - dropPending(db, row.jmap, row.id); - if (server && kind === 'refused') writeCard(db, row.jmap, server); - else removeCard(db, row.jmap, row.id); + recordConflict(ctx, sent, kind, server ?? null, error); + dropPending(db, sent.jmap, sent.id); + const restore = server ?? (sent.base ? JSON.parse(sent.base) as Card : null); + if (restore && kind === 'refused') writeCard(db, sent.jmap, restore); + else removeCard(db, sent.jmap, sent.id); } /** Takes rows up to about the size of one request. */ -function nextBatch(db: StorageAdapter, jmap: string, afterSeq: number): PendingRow[] { - const rows = db.all('SELECT * FROM contact_pending WHERE jmap = ? AND seq > ? ORDER BY seq LIMIT ?', [jmap, afterSeq, SET_BATCH]); +function nextBatch(db: StorageAdapter, jmap: string, afterSeq: number, limits: RequestLimits): PendingRow[] { + const rows = db.all('SELECT * FROM contact_pending WHERE jmap = ? AND seq > ? ORDER BY seq LIMIT ?', [jmap, afterSeq, Math.min(SET_BATCH, limits.maxObjectsInSet)]); + const room = limits.maxSizeRequest / 2; let bytes = 0; const batch: PendingRow[] = []; for (const row of rows) { bytes += row.payload?.length ?? 0; - if (batch.length > 0 && bytes > SET_BATCH_BYTES) break; + if (batch.length > 0 && bytes > room) break; batch.push(row); } return batch; } +/** One exchange with the server for these rows: read, decide, send, read back, settle. */ +async function exchange(ctx: SyncContext, jmap: string, rows: readonly PendingRow[], limits: RequestLimits): Promise { + const { db } = ctx; + const current = await readServerCards(ctx, jmap, rows.filter((row) => row.op !== 'create' && !row.id.startsWith(STAND_IN_PREFIX)).map((row) => row.id), limits); + const serverByUid = await cardsByUid(ctx, jmap, rows.filter((row) => row.uid && row.attempted).map((row) => row.uid as string), limits); + + const out: Decision = { create: new Map(), update: new Map(), destroy: new Map() }; + db.transaction(() => { + for (const { seq, id } of rows) { + // The page may have edited it while the reads were on their way. + const row = pendingFor(db, jmap, id); + if (row && row.seq === seq) decide(ctx, row, current.get(id), serverByUid, out); + } + for (const row of [...out.create.values(), ...out.update.values()]) { + db.run('UPDATE contact_pending SET attempted = 1, sent = payload WHERE seq = ?', [row.seq]); + } + }); + if (out.create.size + out.update.size + out.destroy.size === 0) return; + + const creationIds = new Map([...out.create.values()].map((row) => [`c${row.seq}`, row])); + const response = await ctx.transport.request([['ContactCard/set', { + accountId: jmap, + ...(creationIds.size > 0 ? { create: Object.fromEntries([...creationIds].map(([cid, row]) => [cid, JSON.parse(row.payload as string)])) } : {}), + ...(out.update.size > 0 ? { update: Object.fromEntries([...out.update.values()].map((row) => [row.id, JSON.parse(row.payload as string)])) } : {}), + ...(out.destroy.size > 0 ? { destroy: [...out.destroy.keys()] } : {}), + }, 's']], CONTACTS_USING); + const [, result] = responseFor(response, 's'); + + // What the server now holds. A network failure here is a lost response: the rows stay. + const createdIds = new Map(); + for (const cid of creationIds.keys()) { + const created = result.created?.[cid] as { id?: unknown } | undefined; + if (created?.id) createdIds.set(cid, String(created.id)); + } + const updatedIds = [...out.update.keys()].filter((id) => result.updated && id in result.updated); + const readBack = await readServerCards(ctx, jmap, [...createdIds.values(), ...updatedIds], limits); + // A card already has this uid: maybe this one, sent before. + const uidRefused = [...creationIds].filter(([cid]) => (result.notCreated?.[cid] as SetError | undefined)?.properties?.includes('uid')); + const taken = await cardsByUid(ctx, jmap, uidRefused.map(([, row]) => row.uid as string), limits); + + db.transaction(() => { + for (const [cid, row] of creationIds) { + const realId = createdIds.get(cid); + const refused = result.notCreated?.[cid] as SetError | undefined; + if (realId) { + const card = readBack.get(realId); + if (card) { + settleCreated(ctx, row, card); + } else { + // Created and deleted again already. The delta will say the same. + dropPending(db, jmap, row.id); + removeCard(db, jmap, row.id); + } + } else if (refused?.properties?.includes('uid')) { + const card = taken.get(row.uid as string); + if (card && holdsSent(row.payload as string, card)) settleCreated(ctx, row, card); + else settleRefused(ctx, row, refused, undefined); + } else if (refused) { + settleRefused(ctx, row, refused, undefined); + } + } + for (const [id, row] of out.update) { + const refused = result.notUpdated?.[id] as SetError | undefined; + if (refused) settleRefused(ctx, row, refused, current.get(id)); + else if (updatedIds.includes(id)) settleUpdated(ctx, row, readBack.get(id)); + } + for (const [id, row] of out.destroy) { + const refused = result.notDestroyed?.[id] as SetError | undefined; + if (refused) settleRefused(ctx, row, refused, current.get(id)); + else if ((result.destroyed as string[] | undefined)?.includes(id)) dropPending(db, jmap, id); + } + }); +} + +/** The server said no to the request itself, for a reason that won't go away by itself. */ +function requestRefusal(error: unknown): SetError | null { + if (error instanceof JmapMethodError) return TRANSIENT_ERRORS.has(error.type) ? null : { type: error.type, description: error.message }; + if (error instanceof TransportError && error.kind === 'http' && error.status !== undefined && error.status >= 400 && error.status < 500) { + return { type: 'requestRefused', description: error.message }; + } + return null; +} + +/** One card may be what makes a request fail: the others go one by one, and that one becomes a conflict. */ +async function sendRows(ctx: SyncContext, jmap: string, rows: readonly PendingRow[], limits: RequestLimits): Promise { + try { + await exchange(ctx, jmap, rows, limits); + } catch (error) { + const refusal = requestRefusal(error); + if (!refusal) throw error; + if (rows.length > 1) { + for (const row of rows) { + if (ctx.stopped()) return; + await sendRows(ctx, jmap, [row], limits); + } + return; + } + ctx.db.transaction(() => { + const row = pendingFor(ctx.db, jmap, rows[0].id); + if (row) settleRefused(ctx, row, refusal, undefined); + }); + } +} + /** Sends what's queued for one JMAP account. Network failures reach the engine and the rows stay. */ export async function flushPending(ctx: SyncContext, jmap: string): Promise { - const { db } = ctx; + const limits = requestLimits(ctx.session); let afterSeq = 0; let settled = false; - for (;;) { - if (ctx.stopped()) break; - const batch = nextBatch(db, jmap, afterSeq); - if (batch.length === 0) break; - afterSeq = batch[batch.length - 1].seq; - settled = true; - - const current = await readServerCards(ctx, jmap, batch.filter((row) => row.op !== 'create' && !row.id.startsWith(STAND_IN_PREFIX)).map((row) => row.id)); - const attempted = batch.filter((row) => row.uid && row.attempted).map((row) => row.uid as string); - const uidIds = await lookUpUids(ctx, jmap, attempted); - const uidCards = await readServerCards(ctx, jmap, [...uidIds.values()]); - const serverByUid = new Map(); - for (const [uid, id] of uidIds) { - const card = uidCards.get(id); - if (card) serverByUid.set(uid, card); - } - - const out: Decision = { create: new Map(), update: new Map(), destroy: new Map() }; - db.transaction(() => { - for (const { seq, id } of batch) { - // The page may have edited it while the reads were on their way. - const row = pendingFor(db, jmap, id); - if (row && row.seq === seq) decide(ctx, row, current.get(id), serverByUid, out); - } - for (const row of out.create.values()) db.run('UPDATE contact_pending SET attempted = 1 WHERE seq = ?', [row.seq]); - }); - if (out.create.size + out.update.size + out.destroy.size === 0) continue; - - const creationIds = new Map([...out.create.values()].map((row) => [`c${row.seq}`, row])); - const response = await ctx.transport.request([['ContactCard/set', { - accountId: jmap, - ...(creationIds.size > 0 ? { create: Object.fromEntries([...creationIds].map(([cid, row]) => [cid, JSON.parse(row.payload as string)])) } : {}), - ...(out.update.size > 0 ? { update: Object.fromEntries([...out.update.values()].map((row) => [row.id, JSON.parse(row.payload as string)])) } : {}), - ...(out.destroy.size > 0 ? { destroy: [...out.destroy.keys()] } : {}), - }, 's']], CONTACTS_USING); - const [, result] = responseFor(response, 's'); - - const refusedUid: Array<[PendingRow, SetError]> = []; - db.transaction(() => { - for (const [cid, row] of creationIds) { - const created = result.created?.[cid] as JsonObject | undefined; - const refused = result.notCreated?.[cid] as SetError | undefined; - if (created) { - settleCreated(ctx, row, { ...(JSON.parse(row.payload as string) as JsonObject), ...created, id: String(created.id) }); - } else if (refused?.properties?.includes('uid')) { - refusedUid.push([row, refused]); - } else if (refused) { - settleRefused(ctx, row, refused, undefined); - } - } - for (const [id, row] of out.update) { - const refused = result.notUpdated?.[id] as SetError | undefined; - if (refused) settleRefused(ctx, row, refused, current.get(id)); - else if (result.updated && id in result.updated) settleUpdated(ctx, row, current.get(id) as Card); - } - for (const [id, row] of out.destroy) { - const refused = result.notDestroyed?.[id] as SetError | undefined; - if (refused) settleRefused(ctx, row, refused, current.get(id)); - else if ((result.destroyed as string[] | undefined)?.includes(id)) dropPending(db, jmap, id); - } - }); - - // The server has a card with this uid already: this one, sent before. - if (refusedUid.length > 0) { - const ids = await lookUpUids(ctx, jmap, refusedUid.map(([row]) => row.uid as string)); - const cards = await readServerCards(ctx, jmap, [...ids.values()]); - db.transaction(() => { - for (const [row, refused] of refusedUid) { - const id = ids.get(row.uid as string); - const card = id ? cards.get(id) : undefined; - if (card) settleCreated(ctx, row, { ...(JSON.parse(row.payload as string) as JsonObject), ...card }); - else settleRefused(ctx, row, refused, undefined); - } - }); + try { + for (;;) { + if (ctx.stopped()) break; + const batch = nextBatch(ctx.db, jmap, afterSeq, limits); + if (batch.length === 0) break; + afterSeq = batch[batch.length - 1].seq; + settled = true; + await sendRows(ctx, jmap, batch, limits); } + } finally { + if (settled) ctx.emit({ type: 'changed', account: ctx.account, collections: ['ContactCard'] }); } - if (settled) ctx.emit({ type: 'changed', account: ctx.account, collections: ['ContactCard'] }); } diff --git a/lib/store/contacts/schema.ts b/lib/store/contacts/schema.ts index 66b30832c..9aceaf22b 100644 --- a/lib/store/contacts/schema.ts +++ b/lib/store/contacts/schema.ts @@ -48,6 +48,8 @@ export const CONTACT_MIGRATIONS: readonly Migration[] = [ base TEXT, -- A request may have reached the server, so a create looks for its uid first. attempted INTEGER NOT NULL DEFAULT 0, + -- The payload that request held: the server may have this, not the newer payload. + sent TEXT, queued_at INTEGER NOT NULL, UNIQUE (jmap, id) ); diff --git a/lib/store/contacts/sync.ts b/lib/store/contacts/sync.ts index f734263d6..b06ddc835 100644 --- a/lib/store/contacts/sync.ts +++ b/lib/store/contacts/sync.ts @@ -2,18 +2,24 @@ * Contact sync for one JMAP account: first what's queued goes out, then the * address books, then the cards. A full pass over the cards captures the * state first and pages, with its cursor in sync_state, so a reload continues - * where it stopped. Cards the pass didn't see are gone from the server. + * where it stopped. Cards the pass didn't see are gone from the server, so a + * page must not skip any: it goes from the last card read (`anchor`), since a + * position moves when an earlier card is deleted. Both Stalwarts take that. */ import type { SyncContext, Syncer } from '../area'; import { runChangesLoop } from '../engine/changes'; import { deleteObject, putObject } from '../engine/core-schema'; -import { responseFor, type MethodCall } from '../engine/transport'; +import { requestLimits } from '../engine/limits'; +import { JmapMethodError, responseFor, TransportError, type MethodCall } from '../engine/transport'; import { flushPending, serverDestroyed, storeServerCard } from './pending'; import { ADDRESS_BOOK_PROPERTIES, CONTACTS_CAPABILITY, CONTACTS_USING, type Card } from './records'; -const PAGE = 500; -const PAIRS_PER_REQUEST = 4; +const MOST_PAIRS_PER_REQUEST = 4; + +function pageSize(ctx: SyncContext): number { + return requestLimits(ctx.session).maxObjectsInGet; +} // ---- Address books ---- @@ -42,8 +48,9 @@ async function syncBooks(ctx: SyncContext, jmap: string): Promise { apply: async (page) => { const ids = [...page.created, ...page.updated]; const list: Array<{ id: string }> = []; - for (let i = 0; i < ids.length; i += PAGE) { - const response = await ctx.transport.request([['AddressBook/get', { accountId: jmap, ids: ids.slice(i, i + PAGE), properties: ADDRESS_BOOK_PROPERTIES }, 'b']], CONTACTS_USING); + const size = pageSize(ctx); + for (let i = 0; i < ids.length; i += size) { + const response = await ctx.transport.request([['AddressBook/get', { accountId: jmap, ids: ids.slice(i, i + size), properties: ADDRESS_BOOK_PROPERTIES }, 'b']], CONTACTS_USING); list.push(...responseFor(response, 'b')[1].list); } ctx.db.transaction(() => { @@ -59,14 +66,16 @@ async function syncBooks(ctx: SyncContext, jmap: string): Promise { // ---- Cards ---- -interface ListCursor { position: number; gen: number; captured: string } +interface ListCursor { position: number; anchor: string | null; gen: number; captured: string } async function startFullList(ctx: SyncContext, jmap: string): Promise { const response = await ctx.transport.request([['ContactCard/get', { accountId: jmap, ids: [] }, 's']], CONTACTS_USING); const captured = String(responseFor(response, 's')[1].state); const gen = Number(ctx.db.get<{ gen: number | null }>('SELECT MAX(gen) AS gen FROM contact_card WHERE jmap = ?', [jmap])?.gen ?? 0) + 1; - const cursor: ListCursor = { position: 0, gen, captured }; - ctx.db.transaction(() => ctx.setSyncState(jmap, 'ContactCard', { state: null, phase: 'list', cursor: { ...cursor } })); + const cursor: ListCursor = { position: 0, anchor: null, gen, captured }; + // Answers wait for the end of a first pass (phase `first`). A resync has an older copy to give. + const phase = ctx.syncState(jmap, 'ContactCard').state ? 'list' : 'first'; + ctx.db.transaction(() => ctx.setSyncState(jmap, 'ContactCard', { state: null, phase, cursor: { ...cursor } })); return cursor; } @@ -82,27 +91,47 @@ function sweep(ctx: SyncContext, jmap: string, gen: number): void { async function runFullList(ctx: SyncContext, jmap: string, start: ListCursor): Promise { const cursor = { ...start }; + const limits = requestLimits(ctx.session); + const page = limits.maxObjectsInGet; + const pairs = Math.max(1, Math.min(MOST_PAIRS_PER_REQUEST, Math.floor(limits.maxCallsInRequest / 2))); for (;;) { if (ctx.stopped()) return false; const calls: MethodCall[] = []; - for (let i = 0; i < PAIRS_PER_REQUEST; i += 1) { - calls.push(['ContactCard/query', { accountId: jmap, position: cursor.position + i * PAGE, limit: PAGE, calculateTotal: i === 0 }, `q${i}`]); + for (let i = 0; i < pairs; i += 1) { + const from = cursor.anchor === null ? { position: i * page } : { anchor: cursor.anchor, anchorOffset: 1 + i * page }; + calls.push(['ContactCard/query', { accountId: jmap, ...from, limit: page, calculateTotal: i === 0 }, `q${i}`]); calls.push(['ContactCard/get', { accountId: jmap, '#ids': { resultOf: `q${i}`, name: 'ContactCard/query', path: '/ids' } }, `g${i}`]); } const response = await ctx.transport.request(calls, CONTACTS_USING); let total: number | null = null; let got = 0; + let reached = 0; let short = false; + let last: string | null = null; const cards: Card[] = []; - for (let i = 0; i < PAIRS_PER_REQUEST && !short; i += 1) { - const [, query] = responseFor(response, `q${i}`); - if (i === 0 && typeof query.total === 'number') total = query.total; - cards.push(...responseFor(response, `g${i}`)[1].list as Card[]); - got += (query.ids as string[]).length; - short = (query.ids as string[]).length < PAGE; + try { + for (let i = 0; i < pairs && !short; i += 1) { + const [, query] = responseFor(response, `q${i}`); + const ids = query.ids as string[]; + if (i === 0 && typeof query.total === 'number') total = query.total; + cards.push(...responseFor(response, `g${i}`)[1].list as Card[]); + got += ids.length; + if (ids.length > 0) last = ids[ids.length - 1]; + reached = Number(query.position ?? 0) + ids.length; + short = ids.length < page; + } + } catch (error) { + if (!(error instanceof JmapMethodError && error.type === 'anchorNotFound')) throw error; + // The card it went from is gone. Going through again costs requests, not cards. + cursor.anchor = null; + cursor.position = 0; + ctx.db.transaction(() => ctx.setSyncState(jmap, 'ContactCard', { cursor: { ...cursor } })); + continue; } - cursor.position += got; - const done = got === 0 || (total === null ? short : cursor.position >= total); + if (last !== null) cursor.anchor = last; + cursor.position = reached; + // The server may clamp a page, so a short one only ends this if there's no total to go by. + const done = got === 0 || (total === null ? short : reached >= total); ctx.db.transaction(() => { for (const card of cards) storeServerCard(ctx.db, jmap, card, cursor.gen); if (done) { @@ -132,8 +161,9 @@ async function syncDelta(ctx: SyncContext, jmap: string, since: string, target: apply: async (page) => { const ids = [...page.created, ...page.updated]; const fetched: Card[] = []; - for (let i = 0; i < ids.length; i += PAGE) { - const response = await ctx.transport.request([['ContactCard/get', { accountId: jmap, ids: ids.slice(i, i + PAGE) }, 'g']], CONTACTS_USING); + const size = pageSize(ctx); + for (let i = 0; i < ids.length; i += size) { + const response = await ctx.transport.request([['ContactCard/get', { accountId: jmap, ids: ids.slice(i, i + size) }, 'g']], CONTACTS_USING); fetched.push(...responseFor(response, 'g')[1].list as Card[]); } ctx.db.transaction(() => { @@ -151,7 +181,7 @@ async function syncDelta(ctx: SyncContext, jmap: string, since: string, target: async function syncCards(ctx: SyncContext, jmap: string): Promise { const row = ctx.syncState(jmap, 'ContactCard'); - let cursor = row.phase === 'list' ? row.cursor as unknown as ListCursor : null; + let cursor = row.phase === 'list' || row.phase === 'first' ? row.cursor as unknown as ListCursor : null; if (!cursor && !row.state) cursor = await startFullList(ctx, jmap); if (!cursor && row.state) { const outcome = await syncDelta(ctx, jmap, row.state, row.target); @@ -170,7 +200,14 @@ export const contactsSyncer: Syncer = { name: 'contacts', capability: CONTACTS_CAPABILITY, async run(ctx, jmap) { - await flushPending(ctx, jmap); + try { + await flushPending(ctx, jmap); + } catch (error) { + // No network, no credentials or a busy server is the engine's to handle. + // Anything else leaves the edits queued and mustn't stop contacts syncing. + if (error instanceof TransportError && error.kind !== 'http') throw error; + ctx.emit({ type: 'error', account: ctx.account, area: 'contacts', message: error instanceof Error ? error.message : String(error) }); + } if (ctx.stopped()) return; await syncBooks(ctx, jmap); if (ctx.stopped()) return; diff --git a/lib/store/engine/limits.ts b/lib/store/engine/limits.ts new file mode 100644 index 000000000..e79f8da8e --- /dev/null +++ b/lib/store/engine/limits.ts @@ -0,0 +1,31 @@ +/** What one request may hold: the session's limits, never past the ones the engine was built for. */ + +import type { StoreSession } from './transport'; + +export interface RequestLimits { + maxObjectsInGet: number; + maxObjectsInSet: number; + maxCallsInRequest: number; + maxSizeRequest: number; +} + +const DEFAULTS: RequestLimits = { + maxObjectsInGet: 500, + maxObjectsInSet: 500, + maxCallsInRequest: 16, + maxSizeRequest: 10 * 1024 * 1024, +}; + +export function requestLimits(session: StoreSession): RequestLimits { + const core = (session.capabilities['urn:ietf:params:jmap:core'] ?? {}) as Partial; + const limit = (key: keyof RequestLimits) => { + const value = core[key]; + return typeof value === 'number' && value > 0 ? Math.min(value, DEFAULTS[key]) : DEFAULTS[key]; + }; + return { + maxObjectsInGet: limit('maxObjectsInGet'), + maxObjectsInSet: limit('maxObjectsInSet'), + maxCallsInRequest: limit('maxCallsInRequest'), + maxSizeRequest: limit('maxSizeRequest'), + }; +} From 4c242e6a0cc530f40c1e9af4efc0045d514830e2 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 06:20:40 +0100 Subject: [PATCH 07/20] fix: keep an account's contacts when only another account could answer --- lib/jmap/client.ts | 36 +++++++++++------- lib/jmap/partial-accounts.ts | 27 ++++++++++++++ lib/store/__tests__/client-contacts.test.ts | 23 ++++++++++++ stores/__tests__/contact-store.test.ts | 41 +++++++++++++++++++++ stores/contact-store.ts | 30 ++++++++++++--- 5 files changed, 138 insertions(+), 19 deletions(-) create mode 100644 lib/jmap/partial-accounts.ts diff --git a/lib/jmap/client.ts b/lib/jmap/client.ts index 56258dd86..af3a7e095 100644 --- a/lib/jmap/client.ts +++ b/lib/jmap/client.ts @@ -19,6 +19,7 @@ import { isTaskLikeObject, type ScannedCalendarObject } from "@/lib/calendar-com import { DEFAULT_CALENDAR_COMPONENTS, mkCalendarCollection, newCalendarCollectionName } from "@/lib/webdav/calendar-collection"; import { sanitizeDisplayName, splitMailbox } from "@/lib/rfc5322-mailbox"; import { decodeFileNodeName } from "./filenode-name"; +import { PartialAccountsError } from "./partial-accounts"; import { fileNodeKind, fromDraftFileNode, toDraftFileNodeCreate } from "./filenode-kind"; import { fileNodeDepth } from "./filenode-depth"; import { contactFromWire, contactToWire } from "./contact-wire"; @@ -7327,13 +7328,16 @@ export class JMAPClient implements IJMAPClient { } } - /** Throws when no account could answer, so a failure doesn't read as having no address books. */ + /** + * Throws PartialAccountsError when an account couldn't answer, with what the + * others gave, so a failure doesn't read as that account having no books. + */ async getAllAddressBooks(): Promise { - let answered = 0; + const failed: string[] = []; let failure: unknown; + const allBooks: AddressBook[] = []; + const primaryId = this.getContactsAccountId(); try { - const allBooks: AddressBook[] = []; - const primaryId = this.getContactsAccountId(); const accountIds = this.getContactCapableAccountIds(); for (const accountId of accountIds) { @@ -7356,23 +7360,23 @@ export class JMAPClient implements IJMAPClient { isShared: !isPrimary, })); allBooks.push(...books); - answered += 1; } else if (response.methodResponses?.[0]?.[0] === "error") { const refused = response.methodResponses[0][1]; throw new Error(refused?.description || refused?.type || "AddressBook/get failed"); } } catch (error) { console.error(`Failed to fetch address books for account ${accountId}:`, error); + failed.push(accountId); failure ??= error; } } - if (answered > 0 || !failure) return allBooks; + if (failed.length === 0) return allBooks; } catch (error) { console.error('Failed to fetch all address books:', error); return this.getAddressBooks(); } - throw failure; + throw new PartialAccountsError(allBooks, failed, primaryId, failure); } async createAddressBook(name: string): Promise { @@ -8286,13 +8290,17 @@ export class JMAPClient implements IJMAPClient { } } - /** Throws when no account could answer, so a failure doesn't read as an empty address book. */ + /** + * Throws PartialAccountsError when an account couldn't answer, with what the + * others gave, so a failure doesn't read as that account having no cards. + */ async getAllContacts(): Promise { - let answered = 0; + const failed: string[] = []; let failure: unknown; + let allContacts: ContactCard[] = []; + const primaryId = this.getContactsAccountId(); try { - const allContacts: ContactCard[] = []; - const primaryId = this.getContactsAccountId(); + allContacts = []; const accountIds = this.getContactCapableAccountIds(); for (const accountId of accountIds) { @@ -8313,19 +8321,19 @@ export class JMAPClient implements IJMAPClient { isShared: !isPrimary, })); allContacts.push(...contacts); - answered += 1; } catch (error) { console.error(`Failed to fetch contacts for account ${accountId}:`, error); + failed.push(accountId); failure ??= error; } } - if (answered > 0 || !failure) return allContacts; + if (failed.length === 0) return allContacts; } catch (error) { console.error('Failed to fetch all contacts:', error); return this.getContacts(); } - throw failure; + throw new PartialAccountsError(allContacts, failed, primaryId, failure); } async getContact(contactId: string, accountId?: string): Promise { diff --git a/lib/jmap/partial-accounts.ts b/lib/jmap/partial-accounts.ts new file mode 100644 index 000000000..66d3798a8 --- /dev/null +++ b/lib/jmap/partial-accounts.ts @@ -0,0 +1,27 @@ +/** + * A listing across JMAP accounts where at least one account couldn't answer. + * It carries what the others gave. An account that failed isn't an account + * with nothing in it, so the caller keeps what it had for that one. + */ +export class PartialAccountsError extends Error { + constructor( + readonly items: T[], + readonly failedAccountIds: string[], + readonly primaryAccountId: string, + cause: unknown, + ) { + super(cause instanceof Error ? cause.message : 'An account could not answer'); + this.name = 'PartialAccountsError'; + } +} + +/** By name: `instanceof` fails across Next's bundle copies. */ +export function partialAccounts(error: unknown): PartialAccountsError | null { + return error instanceof Error && error.name === 'PartialAccountsError' ? error as PartialAccountsError : null; +} + +/** What to show after a partial listing: the answers, and what's held for the accounts that failed. */ +export function withFailedAccountsKept(partial: PartialAccountsError, held: readonly T[]): T[] { + const failed = new Set(partial.failedAccountIds); + return [...partial.items, ...held.filter((item) => failed.has(item.accountId ?? partial.primaryAccountId))]; +} diff --git a/lib/store/__tests__/client-contacts.test.ts b/lib/store/__tests__/client-contacts.test.ts index 87d516a34..7e97c18f3 100644 --- a/lib/store/__tests__/client-contacts.test.ts +++ b/lib/store/__tests__/client-contacts.test.ts @@ -6,6 +6,8 @@ import { afterEach, describe, expect, it } from 'vitest'; import { JMAPClient } from '@/lib/jmap/client'; import { setOfflineHooks, type OfflineHooks } from '@/lib/jmap/offline-hooks'; +import { partialAccounts } from '@/lib/jmap/partial-accounts'; +import type { AddressBook, ContactCard } from '@/lib/jmap/types'; import { DEFAULT_SCOPE } from '../area'; import { contactsArea } from '../contacts'; import { AccountEngine } from '../engine/account-engine'; @@ -80,6 +82,27 @@ describe('the client over the store', () => { expect(books.map((b) => b.id).sort()).toEqual(['book1', `${SHARED_ACCOUNT}:teambook`]); }); + it('says which account failed, with what the others gave', async () => { + const { client, engine } = await offlineClient(seeded()); + const failPrimary: Partial = { + skipNetwork: () => true, + answer: async (_client, calls) => (calls[0][1].accountId === JMAP_ACCOUNT + ? { methodResponses: calls.map(([, , id]) => ['error', { type: 'serverUnavailable' }, id]) } + : engine.answer(calls)), + record: () => {}, + noteNetwork: () => {}, + }; + setOfflineHooks(failPrimary as OfflineHooks); + const contacts = await client.getAllContacts().catch((error: unknown) => error); + const partial = partialAccounts(contacts); + expect(partial?.failedAccountIds).toEqual([JMAP_ACCOUNT]); + expect(partial?.primaryAccountId).toBe(JMAP_ACCOUNT); + expect(partial?.items.map((c) => c.name?.full)).toEqual(['Dora Team']); + const books = partialAccounts(await client.getAllAddressBooks().catch((error: unknown) => error)); + expect(books?.failedAccountIds).toEqual([JMAP_ACCOUNT]); + expect(books?.items.map((b) => b.originalId)).toEqual(['teambook']); + }); + it('searches with its own filter', async () => { const { client } = await offlineClient(seeded()); expect((await client.searchContacts('müll')).map((c) => c.name?.full)).toEqual(['Carla Müller']); diff --git a/stores/__tests__/contact-store.test.ts b/stores/__tests__/contact-store.test.ts index f9dfabcca..f52aa4e11 100644 --- a/stores/__tests__/contact-store.test.ts +++ b/stores/__tests__/contact-store.test.ts @@ -13,6 +13,7 @@ import type { AddressBook, ContactCard, ContactMedia } from '@/lib/jmap/types'; import type { IJMAPClient } from '@/lib/jmap/client-interface'; import { clearContactPhotoCache } from '@/lib/contact-photo-cache'; import { PrincipalsRequestError } from '@/lib/jmap/principals-error'; +import { PartialAccountsError } from '@/lib/jmap/partial-accounts'; import { setClientLookup } from '../client-registry'; vi.stubGlobal('crypto', { randomUUID: () => '00000000-0000-0000-0000-000000000000' }); @@ -1387,6 +1388,46 @@ describe('contact-store', () => { expect(state.addressBooks.map((b) => b.id)).toEqual(['acc-a::booka', 'acc-b::bookb']); }); + it('keeps the primary account\'s cards when only a shared account answered', async () => { + const refusal = new PartialAccountsError([makeContact({ id: 'shared:s2', accountId: 'shared', isShared: true })], ['me'], 'me', new Error('offline')); + const failing = { getAllContacts: vi.fn().mockRejectedValue(refusal) } as unknown as IJMAPClient; + useContactStore.setState({ + contacts: [ + makeContact({ id: 'p1', accountId: 'me' }), + // A card just created has no accountId yet: it's the primary account's. + makeContact({ id: 'p2' }), + makeContact({ id: 'shared:s1', accountId: 'shared', isShared: true }), + ], + }); + await useContactStore.getState().fetchContacts(failing); + const state = useContactStore.getState(); + expect(state.contacts.map((c) => c.id).sort()).toEqual(['p1', 'p2', 'shared:s2']); + expect(state.error).toBe('Failed to fetch contacts'); + expect(state.isLoading).toBe(false); + }); + + it('keeps the primary account\'s books when only a shared account answered', async () => { + const refusal = new PartialAccountsError([{ id: 'shared:b', name: 'B', accountId: 'shared' } as AddressBook], ['me'], 'me', new Error('offline')); + const failing = { getAllAddressBooks: vi.fn().mockRejectedValue(refusal) } as unknown as IJMAPClient; + useContactStore.setState({ addressBooks: [{ id: 'mine', name: 'Mine', accountId: 'me' } as AddressBook] }); + await useContactStore.getState().fetchAddressBooks(failing); + expect(useContactStore.getState().addressBooks.map((b) => b.id).sort()).toEqual(['mine', 'shared:b']); + }); + + it('keeps a failed JMAP account of one login while its others refresh', async () => { + const refusal = new PartialAccountsError([makeContact({ id: 's2', accountId: 'shared' })], ['me'], 'me', new Error('offline')); + const failing = { getAllContacts: vi.fn().mockRejectedValue(refusal) } as unknown as IJMAPClient; + useContactStore.setState({ + contacts: [ + makeContact({ id: 'acc-a::p1', accountId: 'me', localAccountId: 'acc-a' }), + makeContact({ id: 'acc-a::s1', accountId: 'shared', localAccountId: 'acc-a' }), + makeContact({ id: 'acc-b::x', accountId: 'me', localAccountId: 'acc-b' }), + ], + }); + await useContactStore.getState().fetchAllAccountsContacts([{ client: failing, localAccountId: 'acc-a' }]); + expect(useContactStore.getState().contacts.map((c) => c.id).sort()).toEqual(['acc-a::p1', 'acc-a::s2']); + }); + it('keeps the list when the only account fails', async () => { const failing = { getAllContacts: vi.fn().mockRejectedValue(new Error('offline')) } as unknown as IJMAPClient; useContactStore.setState({ contacts: [makeContact()] }); diff --git a/stores/contact-store.ts b/stores/contact-store.ts index 3403088b2..924dfc99a 100644 --- a/stores/contact-store.ts +++ b/stores/contact-store.ts @@ -13,6 +13,7 @@ import { sanitizeDisplayName, splitMailbox } from '@/lib/rfc5322-mailbox'; import { inlineContactMedia, writeContactWithNewPhoto, type ContactSaveOptions } from '@/lib/contact-media'; import { contactToView } from '@/lib/plugin-projection'; import { PrincipalsRequestError } from '@/lib/jmap/principals-error'; +import { PartialAccountsError, partialAccounts, withFailedAccountsKept } from '@/lib/jmap/partial-accounts'; import type { Principal } from '@/lib/jmap/types'; import { currentStoreEpoch } from '@/lib/store-epoch'; @@ -614,7 +615,14 @@ export const useContactStore = create()( } catch (error) { if (currentStoreEpoch() !== epoch) return; console.error('Failed to fetch contacts:', error); - set({ error: 'Failed to fetch contacts', isLoading: false, contactsLoaded: true }); + // An account that couldn't answer keeps its cards; the others are fresh. + const partial = partialAccounts(error); + set((state) => ({ + error: 'Failed to fetch contacts', + isLoading: false, + contactsLoaded: true, + contacts: partial ? withFailedAccountsKept(partial, state.contacts) : state.contacts, + })); } }, @@ -656,7 +664,11 @@ export const useContactStore = create()( } catch (error) { if (currentStoreEpoch() !== epoch) return; console.error('Failed to fetch address books:', error); - set({ error: 'Failed to fetch address books' }); + const partial = partialAccounts(error); + set((state) => ({ + error: 'Failed to fetch address books', + addressBooks: partial ? withFailedAccountsKept(partial, state.addressBooks) : state.addressBooks, + })); } }, @@ -671,8 +683,12 @@ export const useContactStore = create()( return prefixContactsWithLocalAccount(list, localAccountId); } catch (error) { debug.error(`Failed to fetch contacts for account ${localAccountId}:`, error); - // Keep what this account's cards were: it just couldn't answer. - return get().contacts.filter((contact) => contact.localAccountId === localAccountId); + // Keep what this login's cards were: it just couldn't answer. + const held = get().contacts.filter((contact) => contact.localAccountId === localAccountId); + const partial = partialAccounts(error); + if (!partial) return held; + const fresh = prefixContactsWithLocalAccount(partial.items, localAccountId); + return withFailedAccountsKept(new PartialAccountsError(fresh, partial.failedAccountIds, partial.primaryAccountId, error), held); } }), ); @@ -695,7 +711,11 @@ export const useContactStore = create()( return prefixAddressBooksWithLocalAccount(list, localAccountId); } catch (error) { debug.error(`Failed to fetch address books for account ${localAccountId}:`, error); - return get().addressBooks.filter((book) => book.localAccountId === localAccountId); + const held = get().addressBooks.filter((book) => book.localAccountId === localAccountId); + const partial = partialAccounts(error); + if (!partial) return held; + const fresh = prefixAddressBooksWithLocalAccount(partial.items, localAccountId); + return withFailedAccountsKept(new PartialAccountsError(fresh, partial.failedAccountIds, partial.primaryAccountId, error), held); } }), ); From c76ba0fee22c4b4383d7f6785126f6f4ab2b3b10 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 08:11:43 +0100 Subject: [PATCH 08/20] feat: let organisations cap what devices keep offline --- .../org/__tests__/offline-section.test.tsx | 27 ++++- .../admin/org/sections/offline-section.tsx | 103 ++++++++++++++++-- lib/__tests__/device-policy.test.ts | 51 +++++++++ .../server-device-offline-caps.test.ts | 29 +++++ lib/admin/organisation-policy.ts | 61 ++++++++++- lib/admin/server-device-policy.ts | 13 +-- lib/device-policy.ts | 13 +-- 7 files changed, 263 insertions(+), 34 deletions(-) create mode 100644 lib/admin/__tests__/server-device-offline-caps.test.ts diff --git a/components/admin/org/__tests__/offline-section.test.tsx b/components/admin/org/__tests__/offline-section.test.tsx index c678f11e6..a5051d4fb 100644 --- a/components/admin/org/__tests__/offline-section.test.tsx +++ b/components/admin/org/__tests__/offline-section.test.tsx @@ -70,6 +70,31 @@ describe('Offline mode section', () => { it('says what a device keeps and links the docs', async () => { await renderSection(); expect(screen.getByRole('link', { name: 'How offline mode works' }).getAttribute('href')).toBe('https://bulwarkmail.org/docs/guides/organisation/offline-mode'); - expect(document.body.textContent).toContain('Bulwark Lite has no offline mode'); + expect(document.body.textContent).toContain('Bulwark Lite reads the same policy but has no offline mode'); + expect(document.body.textContent).not.toContain('250 MB'); + }); + + it('saves the caps as numbers and takes a cleared field as no cap', async () => { + await renderSection(); + const days = screen.getByTestId('org-devices-offlineMaxDays') as HTMLInputElement; + fireEvent.change(days, { target: { value: '45' } }); + fireEvent.change(screen.getByTestId('org-devices-offlineMaxAttachmentMb'), { target: { value: '10' } }); + fireEvent.change(screen.getByTestId('org-devices-offlineMaxTotalMb'), { target: { value: '200' } }); + fireEvent.click(screen.getByTestId('org-devices-noOfflineAttachments')); + await act(async () => { await latest!.save(); }); + expect((puts[0].organisation as { devices: unknown }).devices).toMatchObject({ + offlineMaxDays: 45, offlineMaxAttachmentMb: 10, offlineMaxTotalMb: 200, noOfflineAttachments: true, + }); + fireEvent.change(days, { target: { value: '' } }); + expect(latest!.policy?.organisation?.devices.offlineMaxDays).toBe(0); + expect(days.value).toBe(''); + }); + + it('writes a cap into the scope only', async () => { + await renderSection(); + act(() => latest!.setScopeId('field')); + fireEvent.change(screen.getByTestId('org-devices-offlineMaxDays'), { target: { value: '30' } }); + expect(latest!.policy?.scopes?.[0].policy.organisation).toEqual({ devices: { offlineMaxDays: 30 } }); + expect(latest!.policy?.organisation?.devices.offlineMaxDays).toBe(0); }); }); diff --git a/components/admin/org/sections/offline-section.tsx b/components/admin/org/sections/offline-section.tsx index 17f07df1d..9494654ca 100644 --- a/components/admin/org/sections/offline-section.tsx +++ b/components/admin/org/sections/offline-section.tsx @@ -6,34 +6,113 @@ import type { OrgPolicyDraft } from '../use-org-policy-draft'; const DOCS_URL = 'https://bulwarkmail.org/docs/guides/organisation/offline-mode'; +interface CapField { + key: 'offlineMaxDays' | 'offlineMaxAttachmentMb' | 'offlineMaxTotalMb'; + label: string; + description: string; + unit: string; + max: number; +} + +const CAP_FIELDS: CapField[] = [ + { + key: 'offlineMaxDays', + label: 'Keep mail for at most', + description: 'Mail older than this leaves the device at its next policy fetch, and calendar events that ended before it too. People can still choose less.', + unit: 'days', + max: 3650, + }, + { + key: 'offlineMaxAttachmentMb', + label: 'Largest attachment or file kept', + description: 'Anything bigger is removed from the device and opened from the server when there is a connection.', + unit: 'MB', + max: 1024 * 1024, + }, + { + key: 'offlineMaxTotalMb', + label: 'All attachments and files, per account', + description: 'The oldest go first when a device is over this. Message text isn’t counted: limit that with the days above.', + unit: 'MB', + max: 1024 * 1024, + }, +]; + +const describeCap = (value: number, unit: string) => (value > 0 ? `${value} ${unit}` : 'no limit'); + /** - * Organisation > Devices > Offline mode (#523): whether people may keep - * mail on their devices (policy.json `organisation.devices.noOffline`). - * Users turn offline mode on per device; this switch takes it away, and a - * device that already keeps mail deletes it at its next policy fetch. + * Organisation > Devices > Offline mode (#523): whether people may keep mail + * on their devices, and how much (policy.json `organisation.devices`). These + * win over what a user picks and over the desktop app's default. Nothing on + * the server can check them, since the mail is on the device: the app holds + * itself to them, which the text says. */ export function OfflineSection({ draft }: { draft: OrgPolicyDraft }) { - const { value, own, everyone } = draft.orgValue('devices', 'noOffline'); + const forbid = draft.orgValue('devices', 'noOffline'); + const noAttachments = draft.orgValue('devices', 'noOfflineAttachments'); return (
- draft.setOrgValue('devices', 'noOffline', v)} testId="org-devices-noOffline" /> - draft.clearOrgValue('devices', 'noOffline')} /> + draft.setOrgValue('devices', 'noOffline', v)} testId="org-devices-noOffline" /> + draft.clearOrgValue('devices', 'noOffline')} /> +
+ + {CAP_FIELDS.map((field) => { + const { value, own, everyone } = draft.orgValue('devices', field.key); + return ( + +
+
+ 0 ? value : ''} + onChange={(e) => { + const raw = e.target.value.trim(); + const parsed = raw === '' ? 0 : Math.round(Number(raw)); + if (!Number.isFinite(parsed)) return; + draft.setOrgValue('devices', field.key, Math.min(field.max, Math.max(0, parsed))); + }} + className="h-9 w-28 rounded-md border border-input bg-background px-3 text-sm text-foreground placeholder:text-muted-foreground focus:outline-hidden" + /> + {field.unit} +
+ draft.clearOrgValue('devices', field.key)} /> +
+ + ); + })} + +
+ draft.setOrgValue('devices', 'noOfflineAttachments', v)} testId="org-devices-noOfflineAttachments" /> + draft.clearOrgValue('devices', 'noOfflineAttachments')} />

- What a device keeps: the last 30 days of the Inbox and of the folders the person opens, at most 250 MB, encrypted in - the browser. That protects against someone copying the browser's files, not against someone using the unlocked - browser. Every sign-out, the automatic one after inactivity included, deletes it. With several accounts signed in, - each account follows its own setting. Bulwark Lite has no offline mode.{' '} + What a device keeps: mail in every folder from the window the person picks (30 days, 90 days, a year or everything), + with calendar, contacts and files, encrypted in the browser. That protects against someone copying the browser's + files, not against someone using the unlocked browser. The limits above can only lower what people pick: where several + scopes apply, the lowest value counts, so a scope can't raise what another one lowered. The app holds itself to + them when it fetches the policy; the server can't check what is on a device. Every sign-out, the automatic one + after inactivity included, deletes everything. With several accounts signed in, each account follows its own settings. + Bulwark Lite reads the same policy but has no offline mode.{' '} How offline mode works diff --git a/lib/__tests__/device-policy.test.ts b/lib/__tests__/device-policy.test.ts index fa850e29d..5b1cc5197 100644 --- a/lib/__tests__/device-policy.test.ts +++ b/lib/__tests__/device-policy.test.ts @@ -89,6 +89,57 @@ describe('which account decides', () => { }); }); +describe('offline caps', () => { + const scoped = (id: string, match: object, devices: Record) => ({ id, label: id, match, policy: { organisation: { devices } } }); + + function withPolicy(organisationDevices: Record, scopes: unknown[]) { + usePolicyStore.setState({ rawPolicy: { ...DEFAULT_POLICY, organisation: { devices: organisationDevices }, scopes } as never, loaded: true }); + usePolicyStore.getState().setPolicySubject(null); + usePolicyStore.getState().setPolicySubject(ALICE); + } + + it('stay numbers across signed-in accounts, the lowest one winning', () => { + withPolicy({}, [ + scoped('a', { groups: ['team@example.org'] }, { offlineMaxDays: 90, offlineMaxTotalMb: 500 }), + ]); + const strictest = getStrictestDevices(); + expect(strictest.offlineMaxDays).toBe(90); + expect(strictest.offlineMaxTotalMb).toBe(500); + // Carol has no cap: 0 means none, and must not read as the lowest. + expect(devicesForAccount('acc-c').offlineMaxDays).toBe(0); + }); + + it('a scope can lower a cap but not raise it', () => { + withPolicy({ offlineMaxDays: 60, offlineMaxAttachmentMb: 10 }, [ + scoped('up', { groups: ['team@example.org'] }, { offlineMaxDays: 365, offlineMaxAttachmentMb: 0 }), + ]); + expect(devicesForAccount('acc-a')).toMatchObject({ offlineMaxDays: 60, offlineMaxAttachmentMb: 10 }); + withPolicy({ offlineMaxDays: 60 }, [ + scoped('down', { groups: ['team@example.org'] }, { offlineMaxDays: 7 }), + ]); + expect(devicesForAccount('acc-a').offlineMaxDays).toBe(7); + }); + + it('a scope cannot allow attachments that another one forbids', () => { + withPolicy({ noOfflineAttachments: true }, [ + scoped('up', { groups: ['team@example.org'] }, { noOfflineAttachments: false }), + ]); + expect(devicesForAccount('acc-a').noOfflineAttachments).toBe(true); + }); + + it('noOffline stays last value wins, as before', () => { + withPolicy({ noOffline: true }, [ + scoped('allow', { groups: ['team@example.org'] }, { noOffline: false }), + ]); + expect(devicesForAccount('acc-a').noOffline).toBe(false); + }); + + it('drops what is not a number, and negative caps mean none', () => { + withPolicy({ offlineMaxDays: 'lots', offlineMaxTotalMb: -5 }, []); + expect(devicesForAccount('acc-a')).toMatchObject({ offlineMaxDays: 0, offlineMaxTotalMb: 0 }); + }); +}); + describe('the backstop', () => { it('refuses a download, says so, and never builds the anchor', () => { const click = vi.spyOn(HTMLAnchorElement.prototype, 'click').mockImplementation(() => {}); diff --git a/lib/admin/__tests__/server-device-offline-caps.test.ts b/lib/admin/__tests__/server-device-offline-caps.test.ts new file mode 100644 index 000000000..a6661ea25 --- /dev/null +++ b/lib/admin/__tests__/server-device-offline-caps.test.ts @@ -0,0 +1,29 @@ +import { describe, expect, it } from 'vitest'; +import { DEFAULT_POLICY, type SettingsPolicy } from '../types'; +import { ALL_DEVICE_LIMITS, strictestOfAllScopes } from '../server-device-policy'; + +// The offline caps are numbers in a section that used to hold only booleans. + +const scope = (id: string, devices: Record) => ({ id, label: id, match: { domains: [`${id}.example.org`] }, policy: { organisation: { devices } } }); + +describe('strictest of all scopes', () => { + it('keeps the lowest cap, and a boolean switch still turns on', () => { + const policy = { + ...DEFAULT_POLICY, + organisation: { devices: { offlineMaxDays: 90 } }, + scopes: [scope('a', { offlineMaxDays: 30, offlineMaxTotalMb: 500 }), scope('b', { offlineMaxDays: 60, noPrint: true })], + } as unknown as SettingsPolicy; + expect(strictestOfAllScopes(policy)).toMatchObject({ offlineMaxDays: 30, offlineMaxTotalMb: 500, offlineMaxAttachmentMb: 0, noPrint: true, noExport: false }); + }); + + it('a scope saying 0 does not lift a cap', () => { + const policy = { ...DEFAULT_POLICY, organisation: { devices: { offlineMaxDays: 90 } }, scopes: [scope('a', { offlineMaxDays: 0 })] } as unknown as SettingsPolicy; + expect(strictestOfAllScopes(policy).offlineMaxDays).toBe(90); + }); +}); + +describe('everything on', () => { + it('holds booleans as true and caps as the lowest number', () => { + expect(ALL_DEVICE_LIMITS).toMatchObject({ noOffline: true, noDownloads: true, noOfflineAttachments: true, offlineMaxDays: 1, offlineMaxAttachmentMb: 1, offlineMaxTotalMb: 1 }); + }); +}); diff --git a/lib/admin/organisation-policy.ts b/lib/admin/organisation-policy.ts index 8467c42c8..b49c3f812 100644 --- a/lib/admin/organisation-policy.ts +++ b/lib/admin/organisation-policy.ts @@ -168,6 +168,13 @@ export interface OrganisationPolicy { pushWithoutContent: boolean; watermark: boolean; noOffline: boolean; + /** How far back a device keeps mail, in days. 0 is no cap. Like the other caps, a scope can only lower it. */ + offlineMaxDays: number; + noOfflineAttachments: boolean; + /** The largest attachment or file a device keeps, in MB. 0 is no cap. */ + offlineMaxAttachmentMb: number; + /** All attachments and files of one account on a device, in MB. 0 is no cap. */ + offlineMaxTotalMb: number; }; calendars: { /** Adds up across scopes by id. */ @@ -192,6 +199,7 @@ export const DEFAULT_ORGANISATION_POLICY: OrganisationPolicy = { devices: { noDownloads: false, noExport: false, noPrint: false, noInstallPrompt: false, pushWithoutContent: false, watermark: false, noOffline: false, + offlineMaxDays: 0, noOfflineAttachments: false, offlineMaxAttachmentMb: 0, offlineMaxTotalMb: 0, }, calendars: { feeds: [], freeBusyGroup: '' }, }; @@ -208,6 +216,8 @@ export type DeepPartial = { const MAX_TEXT = 64 * 1024; const MAX_LIBRARY = 200; const MAX_DOMAINS = 500; +const MAX_OFFLINE_DAYS = 3650; +const MAX_OFFLINE_MB = 1024 * 1024; // Same shape as the branding host rule, without the wildcard: a bare domain. const DOMAIN_RE = /^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$/; @@ -530,6 +540,10 @@ export function sanitizeOrganisationPartial(raw: unknown): DeepPartial 0)) return b > 0 ? b : 0; + return b > 0 ? Math.min(a, b) : a; +} + +/** + * Device keys where the strictest value wins across scopes instead of the + * last one: a group scope must not raise what a domain scope lowered. + * noOffline isn't one: a scope may allow it where Everyone forbids it. + */ +const STRICTEST_DEVICE_MERGE: Partial unknown>> = { + offlineMaxDays: tighterCap, + offlineMaxAttachmentMb: tighterCap, + offlineMaxTotalMb: tighterCap, + noOfflineAttachments: (a: boolean, b: boolean) => a || b, +}; + +/** + * Every limit either side sets: for a page that isn't about one account, or a + * login whose scopes can't be worked out. Numbers are caps, so a key may never + * become `true` here. + */ +export function strictestDevices( + base: OrganisationPolicy['devices'], + other: Partial, +): OrganisationPolicy['devices'] { + const out = { ...base } as Record; + for (const [key, value] of Object.entries(other)) { + const current = out[key]; + if (typeof current === 'number') out[key] = tighterCap(current, typeof value === 'number' ? value : 0); + else if (value === true) out[key] = true; + } + return out as OrganisationPolicy['devices']; +} + /** Arrays that add up across scopes by id instead of replacing. */ const ADDITIVE_LISTS: Record = { templates: 'library', vacationTemplates: 'library', calendars: 'feeds' }; @@ -553,10 +603,10 @@ function normaliseMerged(policy: OrganisationPolicy): OrganisationPolicy { /** * Merges `override` into `base` per leaf of plain objects; arrays and values - * replace. Exceptions: the lists in ADDITIVE_LISTS add up by id, and the - * sections in WHOLE_SECTIONS are replaced as a whole (a scope's own label - * scheme or announcement never mixes with the inherited one), with the - * built-in defaults for keys the override leaves out. + * replace. Exceptions: the lists in ADDITIVE_LISTS add up by id, the sections + * in WHOLE_SECTIONS are replaced as a whole (a scope's own label scheme or + * announcement never mixes with the inherited one), with the built-in defaults + * for keys the override leaves out, and the offline caps keep the strictest. */ export function mergeOrganisation( base: OrganisationPolicy, @@ -577,6 +627,9 @@ export function mergeOrganisation( const byId = new Map((merged[key] as Array<{ id: string }>).map((t) => [t.id, t])); for (const item of value as Array<{ id: string }>) byId.set(item.id, item); merged[key] = [...byId.values()]; + } else if (sectionKey === 'devices' && STRICTEST_DEVICE_MERGE[key as keyof OrganisationPolicy['devices']]) { + const pick = STRICTEST_DEVICE_MERGE[key as keyof OrganisationPolicy['devices']] as (a: unknown, b: unknown) => unknown; + merged[key] = pick(merged[key], value); } else { merged[key] = value; } diff --git a/lib/admin/server-device-policy.ts b/lib/admin/server-device-policy.ts index 89cd77084..f72376d44 100644 --- a/lib/admin/server-device-policy.ts +++ b/lib/admin/server-device-policy.ts @@ -14,7 +14,7 @@ import { createHash } from 'node:crypto'; import { configManager } from './config-manager'; -import { DEFAULT_ORGANISATION_POLICY, type OrganisationPolicy } from './organisation-policy'; +import { DEFAULT_ORGANISATION_POLICY, strictestDevices, type OrganisationPolicy } from './organisation-policy'; import { resolvePolicy, type PolicySubject } from './policy-scopes'; import type { SettingsPolicy } from './types'; import { fetchJmapSession } from '@/lib/stalwart/jmap-api'; @@ -75,20 +75,19 @@ export function strictDeviceSubject(creds: DeviceCreds): Promise | undefined; - if (!devices) continue; - for (const key of Object.keys(out) as (keyof ServerDevicePolicy)[]) if (devices[key] === true) out[key] = true; + if (devices) out = strictestDevices(out, devices); } return out; } -/** Everything on: when not even the policy can be read. */ +/** Everything on, and each cap as low as it goes: when not even the policy can be read. */ export const ALL_DEVICE_LIMITS: ServerDevicePolicy = Object.fromEntries( - Object.keys(DEFAULT_ORGANISATION_POLICY.devices).map((key) => [key, true]), + Object.entries(DEFAULT_ORGANISATION_POLICY.devices).map(([key, off]) => [key, typeof off === 'number' ? 1 : true]), ) as ServerDevicePolicy; /** diff --git a/lib/device-policy.ts b/lib/device-policy.ts index 45bce6358..3489e28df 100644 --- a/lib/device-policy.ts +++ b/lib/device-policy.ts @@ -26,7 +26,7 @@ * the export engine and previews read blobs too. */ -import { DEFAULT_ORGANISATION_POLICY, type OrganisationPolicy } from '@/lib/admin/organisation-policy'; +import { DEFAULT_ORGANISATION_POLICY, strictestDevices, type OrganisationPolicy } from '@/lib/admin/organisation-policy'; import { setDownloadGuard } from '@/lib/download-guard'; import { subjectForAccount } from '@/lib/org/account-subjects'; import { useAuthStore } from '@/stores/auth-store'; @@ -37,8 +37,6 @@ export type DevicePolicy = OrganisationPolicy['devices']; export const NO_DEVICE_LIMITS: DevicePolicy = DEFAULT_ORGANISATION_POLICY.devices; -const KEYS = Object.keys(NO_DEVICE_LIMITS) as (keyof DevicePolicy)[]; - function devicesOf(policy: { organisation?: OrganisationPolicy } | null | undefined): DevicePolicy { return { ...NO_DEVICE_LIMITS, ...(policy?.organisation?.devices ?? {}) }; } @@ -99,14 +97,9 @@ export function signedInAccountIds(): string[] { return [...ids]; } -/** Every switch that any signed-in account has on: for pages that aren't about one account. */ +/** Every switch that any signed-in account has on, and the lowest of each cap: for pages that aren't about one account. */ export function getStrictestDevices(): DevicePolicy { - const out: DevicePolicy = { ...devicesForAccount(null) }; - for (const id of signedInAccountIds()) { - const devices = devicesForAccount(id); - for (const key of KEYS) if (devices[key]) out[key] = true; - } - return out; + return signedInAccountIds().reduce((out, id) => strictestDevices(out, devicesForAccount(id)), devicesForAccount(null)); } /** The switches that keep mail in: a copy may only go where they are at least as strict. */ From a7c3c5b9a68192679be1f253259d1b94fd22c8bd Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 08:56:24 +0100 Subject: [PATCH 09/20] feat: prune kept mail at once when the scope tightens and fetch it back when it widens The store took a scope only when it opened and acted on it only at a full sync, so a lower cap left old mail on the device until something else forced a resync. Now the engine applies a changed scope first, without the network, and once a day as the window moves on. Also tell the page whether an account's file was there when it opened, so it can notice a store the browser deleted. - `calendar-sync.test.ts` now syncs with `days: null`: its old events test checks the calendar's own two years, and the calendar follows the scope now - `page-side.test.ts`: the fake worker answers an open with what it found, as the real one does --- lib/store/__tests__/calendar-sync.test.ts | 2 +- .../__tests__/helpers/in-process-store.ts | 7 +- lib/store/__tests__/host.test.ts | 111 ++++++ lib/store/__tests__/mail-sync.test.ts | 2 +- lib/store/__tests__/page-side.test.ts | 3 +- lib/store/__tests__/scope.test.ts | 315 ++++++++++++++++++ lib/store/adapters/wasm.ts | 6 +- lib/store/area.ts | 33 ++ lib/store/calendar/index.ts | 9 +- lib/store/calendar/sync.ts | 33 +- lib/store/client/api.ts | 31 +- lib/store/client/store-client.ts | 14 +- lib/store/engine/account-engine.ts | 90 ++++- lib/store/mail/calls.ts | 3 + lib/store/mail/index.ts | 4 + lib/store/mail/scope.ts | 102 ++++++ lib/store/mail/sync.ts | 6 +- lib/store/worker/host.ts | 49 ++- lib/store/worker/protocol.ts | 7 +- lib/store/worker/worker.ts | 13 +- 20 files changed, 795 insertions(+), 45 deletions(-) create mode 100644 lib/store/__tests__/host.test.ts create mode 100644 lib/store/__tests__/scope.test.ts create mode 100644 lib/store/mail/scope.ts diff --git a/lib/store/__tests__/calendar-sync.test.ts b/lib/store/__tests__/calendar-sync.test.ts index 2b3e90c65..57df95cb6 100644 --- a/lib/store/__tests__/calendar-sync.test.ts +++ b/lib/store/__tests__/calendar-sync.test.ts @@ -22,7 +22,7 @@ function setup(version: StalwartVersion = '1.0', server = new FakeCalendarJmap(v session, transport: server, areas: [calendarArea], - scope: DEFAULT_SCOPE, + scope: { ...DEFAULT_SCOPE, days: null }, emit: (event) => events.push(event), now: () => NOW, sleep: async () => {}, diff --git a/lib/store/__tests__/helpers/in-process-store.ts b/lib/store/__tests__/helpers/in-process-store.ts index 81699f3a3..fb7119c2f 100644 --- a/lib/store/__tests__/helpers/in-process-store.ts +++ b/lib/store/__tests__/helpers/in-process-store.ts @@ -4,7 +4,7 @@ * test hands it a transport. */ -import { DEFAULT_SCOPE } from '../../area'; +import { DEFAULT_SCOPE, type StoreScope } from '../../area'; import { STORE_AREAS } from '../../areas'; import type { StoreBackend } from '../../client/api'; import { AccountEngine } from '../../engine/account-engine'; @@ -75,6 +75,11 @@ export class InProcessStore implements StoreBackend { return (result === undefined ? undefined : structuredClone(result)) as T; } + async setScope(account: string, scope: StoreScope): Promise { + const engine = this.engine(account); + if (engine.setScope(scope)) await engine.requestSync(); + } + async sync(account: string): Promise { await this.engine(account).requestSync(); } diff --git a/lib/store/__tests__/host.test.ts b/lib/store/__tests__/host.test.ts new file mode 100644 index 000000000..cff241a70 --- /dev/null +++ b/lib/store/__tests__/host.test.ts @@ -0,0 +1,111 @@ +// @vitest-environment node +import { describe, expect, it } from 'vitest'; +import { DEFAULT_SCOPE } from '../area'; +import { mailArea } from '../mail'; +import type { StorageAdapter } from '../storage'; +import { StoreHost, type HostStorage } from '../worker/host'; +import { FAKE_SESSION } from './helpers/fake-jmap'; +import { openMemoryStore } from './helpers/node-adapter'; + +const KEY = 'a'.repeat(64); + +function keyError(): Error { + const error = new Error('The local store could not be opened with this key'); + error.name = 'StoreKeyError'; + return error; +} + +class FakeStorage implements HostStorage { + readonly dbs = new Map(); + failNext: Error | null = null; + removed: string[] = []; + files(): string[] { + return [...this.dbs.keys()]; + } + async open(file: string): Promise { + if (this.failNext) { + const error = this.failNext; + this.failNext = null; + throw error; + } + let db = this.dbs.get(file); + if (!db) { + db = openMemoryStore(); + this.dbs.set(file, db); + } + // The host closes a database; the "file" stays for the next open. + return { ...db, exec: db.exec.bind(db), run: db.run.bind(db), all: db.all.bind(db), get: db.get.bind(db), transaction: db.transaction.bind(db), close() {} }; + } + remove(file: string): boolean { + this.removed.push(file); + this.dbs.delete(`${file}-journal`); + return this.dbs.delete(file); + } +} + +function host(storage: FakeStorage): StoreHost { + return new StoreHost({ areas: [mailArea], storage, emit: () => {}, needAuth: () => {} }); +} + +const params = (file: string, session: unknown = FAKE_SESSION, account = 'a') => ({ + account, file, keyHex: KEY, session, scope: DEFAULT_SCOPE, invertedKeywordSort: null, auth: null, +}) as Parameters[0]; + +describe('opening an account', () => { + it('says whether its file was there', async () => { + const storage = new FakeStorage(); + const first = host(storage); + expect(await first.openAccount(params('/a1.db'))).toEqual({ fileExisted: false }); + expect(await first.openAccount(params('/a1.db'))).toEqual({ fileExisted: true }); + await first.closeAll(); + expect(await host(storage).openAccount(params('/a1.db'))).toEqual({ fileExisted: true }); + }); + + it('makes no empty file while it has no session, so the next open can still tell', async () => { + const storage = new FakeStorage(); + await expect(host(storage).openAccount(params('/a1.db', null))).rejects.toThrow('No session'); + expect(storage.files()).toEqual([]); + expect(await host(storage).openAccount(params('/a1.db'))).toEqual({ fileExisted: false }); + }); + + it('starts over from a file its key can\'t read, and says the file is gone', async () => { + const storage = new FakeStorage(); + storage.dbs.set('/a1.db', openMemoryStore()); + storage.failNext = keyError(); + expect(await host(storage).openAccount(params('/a1.db'))).toEqual({ fileExisted: false }); + expect(storage.removed).toEqual(['/a1.db']); + }); + + it('never deletes a file over any other error', async () => { + const storage = new FakeStorage(); + storage.dbs.set('/a1.db', openMemoryStore()); + storage.failNext = new Error('disk I/O error'); + await expect(host(storage).openAccount(params('/a1.db'))).rejects.toThrow('disk I/O'); + expect(storage.removed).toEqual([]); + }); +}); + +describe('files with no key', () => { + it('are deleted, journals included; known ones and those in use stay', async () => { + const storage = new FakeStorage(); + const running = host(storage); + await running.openAccount(params('/ainuse.db')); + storage.dbs.set('/aknown.db', openMemoryStore()); + storage.dbs.set('/aorphan.db', openMemoryStore()); + storage.dbs.set('/aorphan.db-journal', openMemoryStore()); + expect(running.sweepFiles(['/aknown.db'])).toBeGreaterThan(0); + expect(storage.files().sort()).toEqual(['/ainuse.db', '/aknown.db']); + }); +}); + +describe('a scope from another tab', () => { + it('reaches the engine over the channel call', async () => { + const storage = new FakeStorage(); + const running = host(storage); + await running.openAccount(params('/a1.db')); + await running.call('setScope', { account: 'a', scope: { ...DEFAULT_SCOPE, days: 7 } }); + const stored = storage.dbs.get('/a1.db')!.get<{ v: string }>("SELECT v FROM meta WHERE k = 'scope'"); + expect(JSON.parse(String(stored?.v)).days).toBe(7); + await expect(running.call('setScope', { account: 'nobody', scope: DEFAULT_SCOPE })).rejects.toMatchObject({ name: 'StoreAccountClosedError' }); + }); +}); diff --git a/lib/store/__tests__/mail-sync.test.ts b/lib/store/__tests__/mail-sync.test.ts index 13d438c6c..e4424a4a3 100644 --- a/lib/store/__tests__/mail-sync.test.ts +++ b/lib/store/__tests__/mail-sync.test.ts @@ -443,7 +443,7 @@ describe('query plans', () => { }, }; const answer = await answerRequest( - { account: 'a', db: spied as typeof db, session: FAKE_SESSION, scope: EVERYTHING, now: Date.now, emit: () => {}, overlay: (_jmap, _type, records) => records, defaultJmap: JMAP_ACCOUNT, invertedKeywordSort: false }, + { account: 'a', db: spied as typeof db, session: FAKE_SESSION, scope: EVERYTHING, now: Date.now, emit: () => {}, overlay: (_jmap, _type, records) => records, keptByOthers: () => 0, defaultJmap: JMAP_ACCOUNT, invertedKeywordSort: false }, buildMethodTable([mailArea]), [['Email/query', { filter: INBOX, sort: [{ property: 'receivedAt', isAscending: false }], limit: 5 }, 'q']], ); diff --git a/lib/store/__tests__/page-side.test.ts b/lib/store/__tests__/page-side.test.ts index ede57905f..045919141 100644 --- a/lib/store/__tests__/page-side.test.ts +++ b/lib/store/__tests__/page-side.test.ts @@ -25,6 +25,7 @@ class FakeChannel { class FakeWorker { static all: FakeWorker[] = []; + static opened = { fileExisted: true }; onmessage: ((event: MessageEvent) => void) | null = null; posted: Array> = []; terminated = false; @@ -33,7 +34,7 @@ class FakeWorker { } postMessage(message: Record): void { this.posted.push(message); - if (message.kind === 'open') queueMicrotask(() => this.onmessage?.({ data: { kind: 'result', id: message.id } } as MessageEvent)); + if (message.kind === 'open') queueMicrotask(() => this.onmessage?.({ data: { kind: 'result', id: message.id, result: FakeWorker.opened } } as MessageEvent)); } terminate(): void { this.terminated = true; diff --git a/lib/store/__tests__/scope.test.ts b/lib/store/__tests__/scope.test.ts new file mode 100644 index 000000000..eea9d21be --- /dev/null +++ b/lib/store/__tests__/scope.test.ts @@ -0,0 +1,315 @@ +// @vitest-environment node +import { describe, expect, it } from 'vitest'; +import { DEFAULT_SCOPE, type StoreArea, type StoreScope } from '../area'; +import { calendarArea } from '../calendar'; +import { AccountEngine } from '../engine/account-engine'; +import { mailArea } from '../mail'; +import { CALENDAR_SESSION, FakeCalendarJmap } from './helpers/fake-calendar'; +import { FAKE_SESSION, FakeJmap, JMAP_ACCOUNT } from './helpers/fake-jmap'; +import { openMemoryStore } from './helpers/node-adapter'; + +const NOW = Date.UTC(2026, 10, 3); +const DAY = 86_400_000; +const EVERYTHING: StoreScope = { ...DEFAULT_SCOPE, days: null }; +const iso = (daysAgo: number) => new Date(NOW - daysAgo * DAY).toISOString(); + +class Files extends FakeJmap { + downloads: string[] = []; + sizes = new Map(); + override async download(_jmap?: string, blobId?: string): Promise { + this.downloads.push(String(blobId)); + return new Uint8Array(this.sizes.get(String(blobId)) ?? 3); + } + withFile(id: string, blobId: string, size: number, daysAgo: number) { + this.sizes.set(blobId, size); + return this.addEmail({ + id, + receivedAt: iso(daysAgo), + hasAttachment: true, + attachments: [{ partId: '2', blobId, name: `${blobId}.pdf`, type: 'application/pdf', size }], + } as never); + } +} + +function setup(server: FakeJmap, scope: StoreScope, areas: StoreArea[] = [mailArea], clock = { now: NOW }, db = openMemoryStore()) { + const engine = new AccountEngine({ + account: 'a@fake.test', db, session: FAKE_SESSION, transport: server, areas, scope, now: () => clock.now, sleep: async () => {}, + }); + return { engine, db, clock }; +} + +const ids = (db: ReturnType, table = 'email') => db.all<{ id: string }>(`SELECT id FROM ${table} ORDER BY id`).map((row) => row.id); +const blobs = (db: ReturnType) => db.all<{ blob_id: string }>('SELECT blob_id FROM blob ORDER BY blob_id').map((row) => row.blob_id); +const count = (db: ReturnType, table: string) => Number(db.get<{ n: number }>(`SELECT COUNT(*) AS n FROM ${table}`)?.n); + +describe('a tightened scope', () => { + it('prunes mail outside the window without fetching what stays', async () => { + const server = new FakeJmap(); + server.addEmail({ id: 'old', receivedAt: iso(100) }); + server.addEmail({ id: 'mid', receivedAt: iso(40) }); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + const { engine, db } = setup(server, EVERYTHING); + await engine.requestSync(); + expect(ids(db)).toEqual(['mid', 'new', 'old']); + + server.calls.length = 0; + expect(engine.setScope({ ...EVERYTHING, days: 30 })).toBe(true); + await engine.requestSync(); + + expect(ids(db)).toEqual(['new']); + expect(count(db, 'email_body')).toBe(1); + expect(count(db, 'email_mailbox')).toBe(1); + // No resync: neither a listing nor the bodies of what stayed. + expect(server.calls.filter(([name]) => name === 'Email/query')).toEqual([]); + expect(server.calls.filter(([name, args]) => name === 'Email/get' && (args as { fetchAllBodyValues?: boolean }).fetchAllBodyValues)).toEqual([]); + }); + + it('prunes without a network', async () => { + const server = new FakeJmap(); + server.addEmail({ id: 'old', receivedAt: iso(100) }); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + const { engine, db } = setup(server, EVERYTHING); + await engine.requestSync(); + engine.setOnline(false); + server.calls.length = 0; + engine.setScope({ ...EVERYTHING, days: 30 }); + await engine.requestSync(); + expect(ids(db)).toEqual(['new']); + expect(server.calls).toEqual([]); + }); + + it('applies when the store opens under a tighter scope than it was left with', async () => { + const server = new FakeJmap(); + server.addEmail({ id: 'old', receivedAt: iso(100) }); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + const first = setup(server, EVERYTHING); + await first.engine.requestSync(); + await first.engine.close(); + const second = setup(server, { ...EVERYTHING, days: 30 }, [mailArea], { now: NOW }, first.db); + await second.engine.requestSync(); + expect(ids(first.db)).toEqual(['new']); + }); + + it('keeps the last scope when the page can\'t tell yet', async () => { + const server = new FakeJmap(); + server.addEmail({ id: 'old', receivedAt: iso(100) }); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + const first = setup(server, { ...EVERYTHING, days: 30 }); + await first.engine.requestSync(); + await first.engine.close(); + server.calls.length = 0; + const second = new AccountEngine({ + account: 'a@fake.test', db: first.db, session: FAKE_SESSION, transport: server, areas: [mailArea], now: () => NOW, sleep: async () => {}, + }); + await second.requestSync(); + // Not the default's 90 days: that would look like a wider window to fetch. + expect(server.calls.filter(([name]) => name === 'Email/query')).toEqual([]); + expect(ids(first.db)).toEqual(['new']); + }); + + it('moves with the clock, once a day', async () => { + const server = new FakeJmap(); + server.addEmail({ id: 'ageing', receivedAt: iso(29) }); + const { engine, db, clock } = setup(server, { ...EVERYTHING, days: 30 }); + await engine.requestSync(); + expect(ids(db)).toEqual(['ageing']); + clock.now = NOW + 2 * DAY; + await engine.requestSync(); + expect(ids(db)).toEqual([]); + }); + + it('drops attachments when they are forbidden, and can fetch them again', async () => { + const server = new Files(); + server.withFile('m', 'b-1', 10, 1); + const { engine, db } = setup(server, EVERYTHING); + await engine.requestSync(); + expect(blobs(db)).toEqual(['b-1']); + + engine.setScope({ ...EVERYTHING, attachments: false }); + await engine.requestSync(); + expect(blobs(db)).toEqual([]); + expect(ids(db)).toEqual(['m']); + + engine.setScope(EVERYTHING); + await engine.requestSync(); + expect(blobs(db)).toEqual(['b-1']); + }); + + it('drops attachments over the new size', async () => { + const server = new Files(); + server.withFile('small', 'b-small', 10, 1); + server.withFile('big', 'b-big', 1000, 2); + const { engine, db } = setup(server, EVERYTHING); + await engine.requestSync(); + expect(blobs(db)).toEqual(['b-big', 'b-small']); + engine.setScope({ ...EVERYTHING, maxAttachmentBytes: 100 }); + await engine.requestSync(); + expect(blobs(db)).toEqual(['b-small']); + }); + + it('drops the oldest attachments over the new total, and doesn\'t fetch them back', async () => { + const server = new Files(); + server.withFile('newest', 'b-newest', 100, 1); + server.withFile('middle', 'b-middle', 100, 2); + server.withFile('oldest', 'b-oldest', 100, 3); + const { engine, db } = setup(server, EVERYTHING); + await engine.requestSync(); + server.downloads.length = 0; + engine.setScope({ ...EVERYTHING, maxTotalBytes: 150 }); + await engine.requestSync(); + expect(blobs(db)).toEqual(['b-newest']); + expect(server.downloads).toEqual([]); + }); + + it('counts what another area keeps towards the total', async () => { + const server = new Files(); + server.withFile('newest', 'b-newest', 100, 1); + server.withFile('older', 'b-older', 100, 2); + const filesArea: StoreArea = { name: 'files', migrations: [], methods: {}, syncers: [], keptBytes: () => 150 }; + const { engine, db } = setup(server, { ...EVERYTHING, maxTotalBytes: 250 }, [mailArea, filesArea]); + await engine.requestSync(); + expect(blobs(db)).toEqual(['b-newest']); + }); + + it('won\'t record a file the scope doesn\'t allow', async () => { + const server = new Files(); + server.withFile('m', 'b-1', 10, 1); + const { engine, db } = setup(server, { ...EVERYTHING, attachments: false }); + await engine.requestSync(); + expect(await engine.areaCall('mail.recordBlob', { jmap: JMAP_ACCOUNT, blobId: 'b-1', type: null, data: new Uint8Array(10) })).toBe(false); + expect(blobs(db)).toEqual([]); + engine.setScope({ ...EVERYTHING, maxAttachmentBytes: 5 }); + expect(await engine.areaCall('mail.recordBlob', { jmap: JMAP_ACCOUNT, blobId: 'b-1', type: null, data: new Uint8Array(10) })).toBe(false); + engine.setScope(EVERYTHING); + expect(await engine.areaCall('mail.recordBlob', { jmap: JMAP_ACCOUNT, blobId: 'b-1', type: null, data: new Uint8Array(10) })).toBe(true); + }); + + it('stops a pass under way, and the pass after it goes by the new scope', async () => { + const server = new FakeJmap(); + for (let i = 0; i < 700; i += 1) server.addEmail({ receivedAt: iso(100) }); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + const { engine, db } = setup(server, EVERYTHING); + let tightened = false; + server.beforeRequest = (n) => { + if (n >= 3 && !tightened) { + tightened = true; + engine.setScope({ ...EVERYTHING, days: 30 }); + } + }; + await engine.requestSync(); + expect(tightened).toBe(true); + expect(ids(db)).toEqual(['new']); + }); +}); + +describe('a scope changed while one is being applied', () => { + it('fetches back what the first one already removed', async () => { + const server = new FakeJmap(); + server.addEmail({ id: 'old', receivedAt: iso(100) }); + for (let i = 0; i < 450; i += 1) server.addEmail({ id: `mid${i}`, receivedAt: iso(50) }); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + const { engine, db } = setup(server, EVERYTHING); + await engine.requestSync(); + + engine.setScope({ ...EVERYTHING, days: 30 }); + const run = engine.requestSync(); + // One batch in: the rows are going, and the change back arrives before the first is done. + await new Promise((resolve) => setTimeout(resolve, 0)); + expect(count(db, 'email')).toBeLessThan(452); + engine.setScope(EVERYTHING); + await run; + await engine.requestSync(); + expect(count(db, 'email')).toBe(452); + }); +}); + +describe('a loosened scope', () => { + it('starts a backfill of the wider window and keeps the bodies it has', async () => { + const server = new FakeJmap(); + server.addEmail({ id: 'old', receivedAt: iso(100) }); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + const { engine, db } = setup(server, { ...EVERYTHING, days: 30 }); + await engine.requestSync(); + expect(ids(db)).toEqual(['new']); + + server.calls.length = 0; + engine.setScope({ ...EVERYTHING, days: 365 }); + await engine.requestSync(); + expect(ids(db)).toEqual(['new', 'old']); + expect(count(db, 'email_body')).toBe(2); + // The new message's body wasn't fetched again. + const fetchedBodies = server.calls + .filter(([name, args]) => name === 'Email/get' && (args as { fetchAllBodyValues?: boolean }).fetchAllBodyValues) + .flatMap(([, args]) => (args as { ids: string[] }).ids); + expect(fetchedBodies).toEqual(['old']); + }); + + it('does nothing when the scope is the same', async () => { + const server = new FakeJmap(); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + const { engine } = setup(server, { ...EVERYTHING, days: 30 }); + await engine.requestSync(); + expect(engine.setScope({ ...EVERYTHING, days: 30 })).toBe(false); + }); +}); + +describe('the calendar', () => { + function calendarSetup(scope: StoreScope) { + const server = new FakeCalendarJmap('1.0'); + const db = openMemoryStore(); + const engine = new AccountEngine({ + account: 'a@fake.test', db, session: CALENDAR_SESSION, transport: server, areas: [calendarArea], scope, now: () => NOW, sleep: async () => {}, + }); + return { server, db, engine }; + } + + it('follows the window, and series and what is ahead stay', async () => { + const { server, db, engine } = calendarSetup(EVERYTHING); + server.addEvent({ id: 'old', start: '2026-06-01T10:00:00' }); + server.addEvent({ id: 'recent', start: '2026-10-30T10:00:00' }); + server.addEvent({ id: 'ahead', start: '2027-01-01T10:00:00' }); + server.addEvent({ id: 'series', start: '2015-01-01T10:00:00', recurrenceRule: { '@type': 'RecurrenceRule', frequency: 'weekly' } }); + await engine.requestSync(); + expect(ids(db, 'calendar_event')).toEqual(['ahead', 'old', 'recent', 'series']); + + engine.setOnline(false); + engine.setScope({ ...EVERYTHING, days: 30 }); + await engine.requestSync(); + expect(ids(db, 'calendar_event')).toEqual(['ahead', 'recent', 'series']); + + engine.setOnline(true); + await engine.requestSync(); + expect(ids(db, 'calendar_event')).toEqual(['ahead', 'recent', 'series']); + }); + + it('lists again when the window gets wider, since no change will name what was left out', async () => { + const { server, db, engine } = calendarSetup({ ...EVERYTHING, days: 30 }); + server.addEvent({ id: 'old', start: '2026-06-01T10:00:00' }); + await engine.requestSync(); + expect(ids(db, 'calendar_event')).toEqual([]); + engine.setScope({ ...EVERYTHING, days: 365 }); + await engine.requestSync(); + expect(ids(db, 'calendar_event')).toEqual(['old']); + }); +}); + +describe('what the storage page reads', () => { + it('says what each part takes, with the rest under mail, and doesn\'t count freed pages', async () => { + const server = new Files(); + server.withFile('m', 'b-1', 50_000, 1); + server.addEmail({ id: 'old', receivedAt: iso(100), subject: 'x'.repeat(40_000) } as never); + const { engine } = setup(server, EVERYTHING); + await engine.requestSync(); + const before = await engine.areaCall('store.usage', undefined) as { bytes: number; parts: Array<{ part: string; bytes: number; items: number }> }; + const parts = Object.fromEntries(before.parts.map((part) => [part.part, part])); + expect(parts.attachments).toEqual({ part: 'attachments', bytes: 50_000, items: 1 }); + expect(parts.mail.items).toBe(2); + expect(parts.mail.bytes).toBe(before.bytes - 50_000); + + engine.setScope({ ...EVERYTHING, days: 30, attachments: false }); + await engine.requestSync(); + const after = await engine.areaCall('store.usage', undefined) as typeof before; + expect(after.bytes).toBeLessThan(before.bytes - 50_000); + expect(after.parts.find((part) => part.part === 'attachments')?.items).toBe(0); + }); +}); diff --git a/lib/store/adapters/wasm.ts b/lib/store/adapters/wasm.ts index 2870e7eae..3a191cb50 100644 --- a/lib/store/adapters/wasm.ts +++ b/lib/store/adapters/wasm.ts @@ -159,8 +159,10 @@ export class WasmStorage { db.exec(`PRAGMA key = "raw:${keyHex}"`); try { db.selectValue('SELECT count(*) FROM sqlite_master'); - } catch { - throw new StoreKeyError(); + } catch (error) { + // Only "this isn't a database": a passing read error must not read as a lost file. + if (error instanceof Error && /NOTADB|not a database/i.test(error.message)) throw new StoreKeyError(); + throw error; } const pageSize = Number(db.selectValue('PRAGMA page_size')); if (pageSize !== REQUIRED_PAGE_SIZE) throw new Error(`Refusing an unsafe page size: ${pageSize}`); diff --git a/lib/store/area.ts b/lib/store/area.ts index c435a4bce..a7491229e 100644 --- a/lib/store/area.ts +++ b/lib/store/area.ts @@ -31,6 +31,27 @@ export const DEFAULT_SCOPE: StoreScope = { /** The `area` of an error event for a write that failed: a full disk, the browser's quota. */ export const STORAGE_ERROR_AREA = 'storage'; +/** The scope changed, or a day passed and the window moved. `previous` is null on a store that never applied one. */ +export interface ScopeChange { + previous: StoreScope | null; + next: StoreScope; +} + +export type StoragePartName = 'mail' | 'attachments' | 'calendar' | 'contacts' | 'files'; + +/** One line of what an account's file holds. */ +export interface StoreUsagePart { + part: StoragePartName; + bytes: number; + items: number; +} + +/** `store.usage`: what the file holds. `mail` gets what the other parts don't account for. */ +export interface StoreUsage { + bytes: number; + parts: StoreUsagePart[]; +} + export interface SyncStateRow { state: string | null; /** The newest state the server told us about, to know when a run is caught up. */ @@ -57,6 +78,8 @@ export interface StoreContext { emit(event: StoreEvent): void; /** Records of one type as this device shows them: see RecordOverlay. */ overlay(jmap: string, type: string, records: T[]): T[]; + /** Attachments and files the other areas keep: `scope.maxTotalBytes` is for all of them together. */ + keptByOthers(area: string): number; } /** @@ -121,4 +144,14 @@ export interface StoreArea { syncers: readonly Syncer[]; calls?: Readonly>; overlay?: RecordOverlay; + /** + * Brings what's kept in line with the scope. Runs without the network and may + * be interrupted: it runs again until it has finished, so it must be safe to + * repeat. Whatever is fetched back goes through the next sync pass. + */ + applyScope?: (ctx: SyncContext, change: ScopeChange) => void | Promise; + /** For the storage page. */ + usage?: (ctx: Pick) => StoreUsagePart[]; + /** Attachments and file contents it holds: what counts towards `scope.maxTotalBytes`. */ + keptBytes?: (ctx: Pick) => number; } diff --git a/lib/store/calendar/index.ts b/lib/store/calendar/index.ts index 12d908660..c5e8de162 100644 --- a/lib/store/calendar/index.ts +++ b/lib/store/calendar/index.ts @@ -1,7 +1,7 @@ import type { StoreArea } from '../area'; import { CALENDAR_METHODS } from './methods'; import { CALENDAR_MIGRATIONS } from './schema'; -import { calendarSyncer, flushCalendar } from './sync'; +import { applyCalendarScope, calendarSyncer, flushCalendar } from './sync'; import { listConflicts, resolveStandIns } from './writes'; export const calendarArea: StoreArea = { @@ -9,9 +9,16 @@ export const calendarArea: StoreArea = { migrations: CALENDAR_MIGRATIONS, methods: CALENDAR_METHODS, syncers: [calendarSyncer], + applyScope: applyCalendarScope, + usage: (ctx) => { + const row = ctx.db.get<{ bytes: number | null; items: number }>('SELECT SUM(LENGTH(json)) AS bytes, COUNT(*) AS items FROM calendar_event'); + return [{ part: 'calendar', bytes: Number(row?.bytes ?? 0), items: Number(row?.items ?? 0) }]; + }, calls: { 'calendar.flush': (ctx) => flushCalendar(ctx), 'calendar.conflicts': (ctx) => listConflicts(ctx.db), + /** How many writes wait to go out. */ + 'calendar.pending': (ctx) => Number(ctx.db.get<{ n: number }>('SELECT COUNT(*) AS n FROM calendar_pending')?.n ?? 0), 'calendar.resolveStandIns': (ctx, params: { ids: string[] }) => resolveStandIns(ctx.db, params.ids), 'calendar.dismissConflict': (ctx, params: { id: number }) => { ctx.db.run('DELETE FROM calendar_conflict WHERE id = ?', [params.id]); diff --git a/lib/store/calendar/sync.ts b/lib/store/calendar/sync.ts index 71ad94a0c..73088d3fa 100644 --- a/lib/store/calendar/sync.ts +++ b/lib/store/calendar/sync.ts @@ -9,7 +9,7 @@ import { isTaskLikeObject } from '@/lib/calendar-component-detection'; import { SYNTHETIC_ID_PROBE } from '@/lib/recurrence-instances'; -import type { StoreContext, SyncContext, Syncer } from '../area'; +import type { ScopeChange, StoreContext, StoreScope, SyncContext, Syncer } from '../area'; import { runChangesLoop } from '../engine/changes'; import { metaGet, metaSet, putObject } from '../engine/core-schema'; import { JmapMethodError, responseFor, TransportError } from '../engine/transport'; @@ -88,10 +88,15 @@ async function syncCalendars(ctx: SyncContext, jmap: string): Promise { return true; } +/** How far back single events are kept: as far as the scope says, never past the two years. */ +function pastWindowMs(scope: StoreScope): number { + return scope.days === null ? PAST_WINDOW_MS : Math.min(PAST_WINDOW_MS, scope.days * 86_400_000); +} + function inWindow(ctx: SyncContext, event: CalendarObject): boolean { if (isSeries(event) || isTaskLikeObject(event)) return true; const { end } = instantsOf(event, 'UTC'); - return end === null || end >= ctx.now() - PAST_WINDOW_MS; + return end === null || end >= ctx.now() - pastWindowMs(ctx.scope); } interface ListCursor { position: number; gen: number; captured: string } @@ -225,12 +230,28 @@ async function syncEvents(ctx: SyncContext, jmap: string): Promise { } /** Single events that aged out of the window. The window moves on without any change on the server. */ -function pruneOld(ctx: SyncContext, jmap: string): void { - ctx.db.run( +function pruneOld(ctx: SyncContext, jmap: string): number { + return ctx.db.run( `DELETE FROM calendar_event WHERE jmap = ? AND is_series = 0 AND is_task = 0 AND end_ms IS NOT NULL AND end_ms < ? AND NOT EXISTS (SELECT 1 FROM calendar_pending p WHERE p.jmap = calendar_event.jmap AND p.record_id = calendar_event.id)`, - [jmap, ctx.now() - PAST_WINDOW_MS], - ); + [jmap, ctx.now() - pastWindowMs(ctx.scope)], + ).changes; +} + +/** + * Tighter: old single events go now, without the server. Wider: they weren't + * kept and no /changes will name them, so the next pass lists everything again. + */ +export function applyCalendarScope(ctx: SyncContext, { previous, next }: ScopeChange): void { + const jmaps = ctx.db.all<{ jmap: string }>('SELECT DISTINCT jmap FROM calendar_event').map((row) => row.jmap); + const removed = jmaps.reduce((sum, jmap) => sum + pruneOld(ctx, jmap), 0); + if (removed > 0) ctx.emit({ type: 'changed', account: ctx.account, collections: ['CalendarEvent'] }); + if (!previous || pastWindowMs(next) <= pastWindowMs(previous)) return; + ctx.db.transaction(() => { + for (const { jmap } of ctx.db.all<{ jmap: string }>("SELECT jmap FROM sync_state WHERE type = 'CalendarEvent'")) { + ctx.setSyncState(jmap, 'CalendarEvent', { state: null, phase: null, cursor: null }); + } + }); } /** diff --git a/lib/store/client/api.ts b/lib/store/client/api.ts index f74b0f52e..d2b1f5532 100644 --- a/lib/store/client/api.ts +++ b/lib/store/client/api.ts @@ -5,14 +5,15 @@ * configureStore, so the worker bundle stays free of them. */ -import { DEFAULT_SCOPE, type StoreEvent, type StoreScope } from '../area'; +import type { StoreEvent, StoreScope } from '../area'; import type { JmapResponse, MethodCall, StoreSession } from '../engine/transport'; -import { forgetAccountKey, getAccountRecord, openAccountKey, type WrapLayer } from './keys'; +import { forgetAccountKey, getAccountRecord, listAccountRecords, openAccountKey, type WrapLayer } from './keys'; import { StoreClient } from './store-client'; export interface StoreAccountInputs { session: StoreSession | null; auth: string | null; + /** Left out while the organisation's policy isn't known: the store keeps the last one. */ scope?: StoreScope; invertedKeywordSort: boolean | null; } @@ -23,6 +24,8 @@ export interface StorePageHooks { /** Runs the client's refresh path; the fresh Authorization header, or null. */ refreshAuth(account: string): Promise; onEvent(event: StoreEvent): void; + /** What opening an account found: its key from before, and its file. Owner tab only. */ + onOpened?(account: string, found: { hadKey: boolean; fileExisted: boolean }): void; /** Wrap layers on top of the WebCrypto one (desktop keychain, app lock). */ keyLayers?(): readonly WrapLayer[]; } @@ -36,6 +39,8 @@ export interface StoreBackend { refresh(account: string): void; answer(account: string, calls: MethodCall[]): Promise; area(account: string, name: string, params?: unknown): Promise; + /** What the store may keep. A tightened scope prunes at once, also without a network. */ + setScope(account: string, scope: StoreScope): Promise; sync(account: string): Promise; noteStateChange(account: string, changed: Record>): Promise; setOnline(online: boolean): Promise; @@ -75,6 +80,7 @@ class PageStore implements StoreBackend { onOwner: () => { this.opening.clear(); for (const account of this.wanted.keys()) void this.openHere(account).catch(() => {}); + void this.sweepOrphans(); }, onNeedAuth: (account) => { void (this.hooks()?.refreshAuth(account) ?? Promise.resolve(null)) @@ -95,23 +101,35 @@ class PageStore implements StoreBackend { this.broken = false; } + /** Files whose key is gone can't be read by anyone: they only take room. */ + private async sweepOrphans(): Promise { + try { + const records = await listAccountRecords(); + await this.client?.sweepFiles(records.map((record) => record.file)); + } catch { + // Tried again the next time this tab or another becomes the owner. + } + } + /** Only the owner may open: the key goes to this tab's own worker, never over the channel. */ private openHere(account: string): Promise { const running = this.opening.get(account); if (running) return running; const run = (async () => { const client = this.started(); + const hadKey = Boolean(await getAccountRecord(account)); const { keyHex, record } = await openAccountKey(account, this.hooks()?.keyLayers?.() ?? []); const inputs = this.hooks()?.inputs(account) ?? { session: null, auth: null, invertedKeywordSort: null }; - await client.openAccount({ + const { fileExisted } = await client.openAccount({ account, file: record.file, keyHex, session: inputs.session ?? this.wanted.get(account) ?? null, - scope: inputs.scope ?? DEFAULT_SCOPE, + scope: inputs.scope, invertedKeywordSort: inputs.invertedKeywordSort, auth: inputs.auth, }); + this.hooks()?.onOpened?.(account, { hadKey, fileExisted }); })(); this.opening.set(account, run); run.catch(() => this.opening.delete(account)); @@ -132,6 +150,7 @@ class PageStore implements StoreBackend { if (!inputs) return; if (inputs.session) client.setSession(account, inputs.session); client.setAuth(account, inputs.auth); + if (inputs.scope) void client.setScope(account, inputs.scope).catch(() => {}); if (inputs.invertedKeywordSort !== null) client.setInvertedKeywordSort(account, inputs.invertedKeywordSort); } @@ -157,6 +176,10 @@ class PageStore implements StoreBackend { return this.whenOpen(account, (client) => client.area(account, name, params)); } + setScope(account: string, scope: StoreScope): Promise { + return this.whenOpen(account, (client) => client.setScope(account, scope)); + } + sync(account: string): Promise { return this.whenOpen(account, (client) => client.sync(account)); } diff --git a/lib/store/client/store-client.ts b/lib/store/client/store-client.ts index 13b4af661..9935d6471 100644 --- a/lib/store/client/store-client.ts +++ b/lib/store/client/store-client.ts @@ -220,10 +220,14 @@ export class StoreClient { return this.isOwner; } - openAccount(params: OpenAccountParams): Promise { + openAccount(params: OpenAccountParams): Promise<{ fileExisted: boolean }> { return this.direct({ kind: 'open', id: crypto.randomUUID(), params }); } + sweepFiles(known: string[]): Promise { + return this.direct({ kind: 'sweep-files', id: crypto.randomUUID(), known }); + } + closeAccount(account: string): Promise { return this.direct({ kind: 'close-account', id: crypto.randomUUID(), account }); } @@ -236,10 +240,6 @@ export class StoreClient { this.post({ kind: 'set-session', account, session }); } - setScope(account: string, scope: StoreScope): void { - this.post({ kind: 'set-scope', account, scope }); - } - setInvertedKeywordSort(account: string, inverted: boolean): void { this.post({ kind: 'set-inverted', account, inverted }); } @@ -283,6 +283,10 @@ export class StoreClient { return this.rpc('sync', { account }, SYNC_TIMEOUT_MS); } + setScope(account: string, scope: StoreScope): Promise { + return this.rpc('setScope', { account, scope }); + } + removeAccount(account: string, file: string): Promise { return this.rpc('removeAccount', { account, file }); } diff --git a/lib/store/engine/account-engine.ts b/lib/store/engine/account-engine.ts index df9452248..252ec0d84 100644 --- a/lib/store/engine/account-engine.ts +++ b/lib/store/engine/account-engine.ts @@ -4,7 +4,7 @@ * the UI. Nothing here touches the DOM, so tests run it on node:sqlite. */ -import { MethodError, STORAGE_ERROR_AREA, type AreaCall, type MethodHandler, type RecordOverlay, type StoreArea, type StoreContext, type StoreEvent, type StoreScope, type SyncContext, type SyncStateRow, type Syncer } from '../area'; +import { DEFAULT_SCOPE, MethodError, STORAGE_ERROR_AREA, type AreaCall, type MethodHandler, type RecordOverlay, type StoreArea, type StoreContext, type StoreEvent, type StoreScope, type StoreUsage, type SyncContext, type SyncStateRow, type Syncer } from '../area'; import { isStorageFailure, migrate, type StorageAdapter } from '../storage'; import { answerRequest, buildMethodTable } from './responder'; import { TransportError, type JmapResponse, type JmapTransport, type MethodCall, type StoreSession } from './transport'; @@ -16,7 +16,8 @@ export interface AccountEngineOptions { session: StoreSession; transport: JmapTransport; areas: readonly StoreArea[]; - scope: StoreScope; + /** Left out when the page can't tell yet (the policy hasn't arrived): the last one stays. */ + scope?: StoreScope; invertedKeywordSort?: boolean; emit?: (event: StoreEvent) => void; now?: () => number; @@ -29,6 +30,13 @@ const RATE_BACKOFF_MS = 2_000; /** After a failed write: the first wait, and the longest. */ const STORAGE_BACKOFF_MS = 60_000; const STORAGE_BACKOFF_MAX_MS = 60 * 60_000; +/** The window moves on without anything changing on the server. */ +const SCOPE_TIDY_MS = 24 * 60 * 60_000; +const SCOPE_KEY = 'scope'; +const SCOPE_APPLIED_KEY = 'scope_applied'; +/** Set while one is being applied: part of it may be done, so that's what the next one starts from. */ +const SCOPE_APPLYING_KEY = 'scope_applying'; +const SCOPE_TIDIED_KEY = 'scope_tidied_at'; export class AccountEngine { readonly account: string; @@ -36,6 +44,7 @@ export class AccountEngine { private session: StoreSession; private scope: StoreScope; private readonly transport: JmapTransport; + private readonly areas: readonly StoreArea[]; private readonly syncers: readonly Syncer[]; private readonly methods: ReadonlyMap; private readonly calls = new Map(); @@ -51,12 +60,14 @@ export class AccountEngine { /** A write failed (full disk, quota): no sync before this time, however much the server pushes. */ private storageBlockedUntil = 0; private storageFailures = 0; + /** The scope changed: a pass under way stops, and what's kept is brought in line first. */ + private scopeChanged = false; constructor(options: AccountEngineOptions) { this.account = options.account; this.db = options.db; this.session = options.session; - this.scope = options.scope; + this.areas = options.areas; this.transport = options.transport; this.syncers = options.areas.flatMap((area) => area.syncers); this.methods = buildMethodTable(options.areas); @@ -70,8 +81,12 @@ export class AccountEngine { this.emitter = options.emit ?? (() => {}); this.now = options.now ?? Date.now; this.sleep = options.sleep ?? ((ms) => new Promise((resolve) => setTimeout(resolve, ms))); + this.calls.set('store.usage', () => this.usage()); migrate(this.db, [...CORE_MIGRATIONS, ...options.areas.flatMap((area) => area.migrations)]); metaSet(this.db, 'session', JSON.stringify(options.session)); + const storedScope = metaGet(this.db, SCOPE_KEY); + this.scope = options.scope ?? (storedScope ? JSON.parse(storedScope) as StoreScope : DEFAULT_SCOPE); + metaSet(this.db, SCOPE_KEY, JSON.stringify(this.scope)); // An offline start has no way to probe the server, so the last answer stays. this.invertedKeywordSort = options.invertedKeywordSort ?? metaGet(this.db, 'inverted_keyword_sort') === '1'; if (options.invertedKeywordSort !== undefined) metaSet(this.db, 'inverted_keyword_sort', options.invertedKeywordSort ? '1' : '0'); @@ -89,11 +104,64 @@ export class AccountEngine { metaSet(this.db, 'session', JSON.stringify(session)); } - setScope(scope: StoreScope): void { + /** True when this is a change. The caller asks for a sync, which applies it, also offline. */ + setScope(scope: StoreScope): boolean { + const json = JSON.stringify(scope); + if (json === JSON.stringify(this.scope)) return false; this.scope = scope; + this.scopeChanged = true; // The user may just have made room by keeping less. this.storageBlockedUntil = 0; - metaSet(this.db, 'scope', JSON.stringify(scope)); + metaSet(this.db, SCOPE_KEY, json); + return true; + } + + /** False when something more urgent than a sync came up: the disk is full. */ + private async applyScope(): Promise { + const wanted = JSON.stringify(this.scope); + const applied = metaGet(this.db, SCOPE_APPLYING_KEY) ?? metaGet(this.db, SCOPE_APPLIED_KEY); + const tidied = Number(metaGet(this.db, SCOPE_TIDIED_KEY) ?? 0); + this.scopeChanged = false; + if (applied === wanted && metaGet(this.db, SCOPE_APPLYING_KEY) === null && this.now() - tidied < SCOPE_TIDY_MS) return true; + const ctx: SyncContext = { ...this.syncContext(), stopped: () => this.closed || this.scopeChanged }; + const change = { previous: applied ? JSON.parse(applied) as StoreScope : null, next: this.scope }; + metaSet(this.db, SCOPE_APPLYING_KEY, wanted); + try { + for (const area of this.areas) await area.applyScope?.(ctx, change); + } catch (error) { + if (isStorageFailure(error)) { + this.noteStorageFailure(error); + return false; + } + // What's kept stays as it is, and this runs again at the next pass. + this.emitter({ type: 'error', account: this.account, area: 'scope', message: error instanceof Error ? error.message : String(error) }); + return true; + } + if (ctx.stopped()) return !this.closed; + this.db.transaction(() => { + metaSet(this.db, SCOPE_APPLIED_KEY, wanted); + metaSet(this.db, SCOPE_APPLYING_KEY, null); + metaSet(this.db, SCOPE_TIDIED_KEY, String(this.now())); + }); + return true; + } + + private keptByOthers(name: string): number { + return this.areas.reduce((sum, area) => sum + (area.name === name ? 0 : area.keptBytes?.({ db: this.db }) ?? 0), 0); + } + + /** Free pages stay in the file for the next writes, so they don't count as used. */ + private usage(): StoreUsage { + const pages = Number(this.db.get<{ page_count: number }>('PRAGMA page_count')?.page_count ?? 0); + const free = Number(this.db.get<{ freelist_count: number }>('PRAGMA freelist_count')?.freelist_count ?? 0); + const size = Number(this.db.get<{ page_size: number }>('PRAGMA page_size')?.page_size ?? 0); + const bytes = (pages - free) * size; + const parts = this.areas.flatMap((area) => area.usage?.({ db: this.db }) ?? []); + const counted = parts.reduce((sum, part) => sum + part.bytes, 0); + return { + bytes, + parts: parts.map((part) => (part.part === 'mail' ? { ...part, bytes: Math.max(0, bytes - counted) } : part)), + }; } setInvertedKeywordSort(inverted: boolean): void { @@ -161,8 +229,9 @@ export class AccountEngine { private async runLoop(): Promise { do { this.again = false; - await this.runOnce(); - } while (this.again && !this.closed && this.online && this.now() >= this.storageBlockedUntil); + if (await this.applyScope()) await this.runOnce(); + // A changed scope is applied without the network too. + } while (!this.closed && this.now() >= this.storageBlockedUntil && (this.scopeChanged || (this.again && this.online))); } private async runOnce(): Promise { @@ -173,10 +242,11 @@ export class AccountEngine { for (const jmap of jmapAccounts) { const capabilities = this.session.accounts[jmap].accountCapabilities ?? this.session.capabilities; if (!(syncer.capability in capabilities)) continue; - if (this.closed || !this.online) return; + if (this.closed || !this.online || this.scopeChanged) return; if (!(await this.runSyncer(ctx, syncer, jmap))) return; } } + if (this.scopeChanged) return; this.storageFailures = 0; if (!this.closed && this.online) this.emitter({ type: 'synced', account: this.account, at: this.now() }); } @@ -233,10 +303,11 @@ export class AccountEngine { transport: this.transport, now: this.now, emit: this.emitter, - stopped: () => this.closed || !this.online, + stopped: () => this.closed || !this.online || this.scopeChanged, syncState: (jmap, type) => this.syncState(jmap, type), setSyncState: (jmap, type, row) => this.setSyncState(jmap, type, row), overlay: (jmap, type, records) => this.overlay(jmap, type, records), + keptByOthers: (area) => this.keptByOthers(area), }; } @@ -249,6 +320,7 @@ export class AccountEngine { now: this.now, emit: this.emitter, overlay: (jmap, type, records) => this.overlay(jmap, type, records), + keptByOthers: (area) => this.keptByOthers(area), }; } diff --git a/lib/store/mail/calls.ts b/lib/store/mail/calls.ts index 429b55dd5..7a3dbe441 100644 --- a/lib/store/mail/calls.ts +++ b/lib/store/mail/calls.ts @@ -34,6 +34,9 @@ function recordOpened(ctx: StoreContext, params: { jmap: string; emails: EmailOb /** A file of a kept message the user opened. Nothing else is kept: not an export, not a stray file. */ function recordBlob(ctx: StoreContext, params: { jmap: string; blobId: string; type: string | null; data: Uint8Array }): boolean { + if (!ctx.scope.attachments || params.data.byteLength > ctx.scope.maxAttachmentBytes) return false; + const used = Number(ctx.db.get<{ n: number | null }>('SELECT SUM(size) AS n FROM blob')?.n ?? 0); + if (used + ctx.keptByOthers('mail') + params.data.byteLength > ctx.scope.maxTotalBytes) return false; const owner = ctx.db.get<{ received_at: number }>('SELECT received_at FROM email_part WHERE jmap = ? AND blob_id = ?', [params.jmap, params.blobId]); if (!owner) return false; putBlob(ctx.db, params.jmap, params.blobId, params.type, params.data, Number(owner.received_at)); diff --git a/lib/store/mail/index.ts b/lib/store/mail/index.ts index aa0ba6e6b..452a199fc 100644 --- a/lib/store/mail/index.ts +++ b/lib/store/mail/index.ts @@ -2,6 +2,7 @@ import type { StoreArea } from '../area'; import { MAIL_CALLS } from './calls'; import { MAIL_METHODS } from './methods'; import { MAIL_MIGRATIONS } from './schema'; +import { applyMailScope, mailUsage } from './scope'; import { SEARCH_MIGRATIONS } from './search-schema'; import { identitySyncer, mailSyncer, quotaSyncer } from './sync'; @@ -11,4 +12,7 @@ export const mailArea: StoreArea = { methods: MAIL_METHODS, syncers: [mailSyncer, identitySyncer, quotaSyncer], calls: MAIL_CALLS, + applyScope: applyMailScope, + usage: mailUsage, + keptBytes: (ctx) => Number(ctx.db.get<{ n: number | null }>('SELECT SUM(size) AS n FROM blob')?.n ?? 0), }; diff --git a/lib/store/mail/scope.ts b/lib/store/mail/scope.ts new file mode 100644 index 000000000..d2cc201e5 --- /dev/null +++ b/lib/store/mail/scope.ts @@ -0,0 +1,102 @@ +/** + * What a changed scope means for kept mail. Tightened: what falls outside goes + * right away, without the network and without fetching what stays. Loosened: + * the next pass lists the wider window, keeping every body already here. + */ + +import type { ScopeChange, StoreUsagePart, SyncContext } from '../area'; +import { deleteEmailRow } from './records'; + +const DELETE_BATCH = 200; +const BLOB_BATCH = 20; + +/** Other calls and syncs get a turn between batches. */ +const breathe = () => new Promise((resolve) => setTimeout(resolve, 0)); + +function cutoff(ctx: SyncContext, days: number): number { + return ctx.now() - days * 86_400_000; +} + +function widened(previous: number | null, next: number | null): boolean { + if (previous === null) return false; + return next === null || next > previous; +} + +async function pruneWindow(ctx: SyncContext, days: number): Promise { + const before = cutoff(ctx, days); + let removed = false; + for (const { jmap } of ctx.db.all<{ jmap: string }>('SELECT DISTINCT jmap FROM email')) { + for (;;) { + if (ctx.stopped()) return; + // A change waiting for one of these goes out by its id, whether it's kept or not. + const rows = ctx.db.all<{ rowid: number }>('SELECT rowid FROM email WHERE jmap = ? AND received_at < ? LIMIT ?', [jmap, before, DELETE_BATCH]); + if (rows.length === 0) break; + ctx.db.transaction(() => { + for (const row of rows) deleteEmailRow(ctx.db, Number(row.rowid)); + }); + removed = true; + await breathe(); + } + } + if (removed) ctx.emit({ type: 'changed', account: ctx.account, collections: ['Email'] }); +} + +/** The rows stay in email_part, so a loosened scope can fetch them again. */ +async function dropBlobs(ctx: SyncContext, select: () => Array<{ jmap: string; blob_id: string }>): Promise { + for (;;) { + if (ctx.stopped()) return; + const rows = select(); + if (rows.length === 0) return; + ctx.db.transaction(() => { + for (const row of rows) ctx.db.run('DELETE FROM blob WHERE jmap = ? AND blob_id = ?', [row.jmap, row.blob_id]); + }); + await breathe(); + } +} + +export async function pruneAttachments(ctx: SyncContext): Promise { + const { scope } = ctx; + if (!scope.attachments) { + await dropBlobs(ctx, () => ctx.db.all('SELECT jmap, blob_id FROM blob LIMIT ?', [BLOB_BATCH])); + return; + } + await dropBlobs(ctx, () => ctx.db.all('SELECT jmap, blob_id FROM blob WHERE size > ? LIMIT ?', [scope.maxAttachmentBytes, BLOB_BATCH])); + // The total is for all kept files of the account, so what the Files area holds takes its part. + const allowed = scope.maxTotalBytes - ctx.keptByOthers('mail'); + await dropBlobs(ctx, () => { + const used = Number(ctx.db.get<{ n: number | null }>('SELECT SUM(size) AS n FROM blob')?.n ?? 0); + if (used <= allowed) return []; + const out: Array<{ jmap: string; blob_id: string }> = []; + let over = used - allowed; + for (const row of ctx.db.all<{ jmap: string; blob_id: string; size: number }>('SELECT jmap, blob_id, size FROM blob ORDER BY at ASC LIMIT ?', [BLOB_BATCH])) { + if (over <= 0) break; + out.push({ jmap: row.jmap, blob_id: row.blob_id }); + over -= Number(row.size); + } + return out; + }); +} + +export async function applyMailScope(ctx: SyncContext, { previous, next }: ScopeChange): Promise { + // First, in case this gets interrupted: a pass under way pages by the old + // window, so it starts over, tighter or wider. + if (previous && previous.days !== next.days) { + ctx.db.transaction(() => { + for (const { jmap, state, phase } of ctx.db.all<{ jmap: string; state: string | null; phase: string | null }>("SELECT jmap, state, phase FROM sync_state WHERE type = 'Email'")) { + if (phase === 'list' || (state && widened(previous.days, next.days))) ctx.setSyncState(jmap, 'Email', { state: null, phase: null, cursor: null }); + } + }); + } + if (next.days !== null) await pruneWindow(ctx, next.days); + await pruneAttachments(ctx); +} + +/** Message text and the search index aren't counted here: they are what's left of the file. */ +export function mailUsage(ctx: Pick): StoreUsagePart[] { + const blobs = ctx.db.get<{ bytes: number | null; items: number }>('SELECT SUM(size) AS bytes, COUNT(*) AS items FROM blob'); + const messages = ctx.db.get<{ items: number }>('SELECT COUNT(*) AS items FROM email'); + return [ + { part: 'mail', bytes: 0, items: Number(messages?.items ?? 0) }, + { part: 'attachments', bytes: Number(blobs?.bytes ?? 0), items: Number(blobs?.items ?? 0) }, + ]; +} diff --git a/lib/store/mail/sync.ts b/lib/store/mail/sync.ts index ebe43fecc..d1cff16d3 100644 --- a/lib/store/mail/sync.ts +++ b/lib/store/mail/sync.ts @@ -11,6 +11,7 @@ import type { SyncContext, Syncer } from '../area'; import { deleteObject, putObject } from '../engine/core-schema'; import { runChangesLoop } from '../engine/changes'; import { JmapMethodError, responseFor, TransportError, type MethodCall } from '../engine/transport'; +import { pruneAttachments } from './scope'; import { deleteEmail, deleteEmailRow, @@ -357,7 +358,10 @@ async function backfillBodies(ctx: SyncContext, jmap: string): Promise { */ async function fetchAttachments(ctx: SyncContext, jmap: string): Promise { if (!ctx.scope.attachments) return; - let used = Number(ctx.db.get<{ n: number | null }>('SELECT SUM(size) AS n FROM blob')?.n ?? 0); + // The Files area may have taken its part of the total since the last pass. + const others = ctx.keptByOthers('mail'); + await pruneAttachments(ctx); + let used = others + Number(ctx.db.get<{ n: number | null }>('SELECT SUM(size) AS n FROM blob')?.n ?? 0); for (;;) { if (ctx.stopped()) return; const parts = ctx.db.all<{ blob_id: string; size: number; type: string | null; name: string | null; received_at: number }>( diff --git a/lib/store/worker/host.ts b/lib/store/worker/host.ts index 9b56b594b..0620d05b3 100644 --- a/lib/store/worker/host.ts +++ b/lib/store/worker/host.ts @@ -12,6 +12,8 @@ import type { OpenAccountParams, StoreRpc, StoreStatus } from './protocol'; export interface HostStorage { open(file: string, keyHex: string): Promise; remove(file: string): boolean; + /** Database files in the pool. Their names say nothing about the accounts. */ + files(): string[]; } interface OpenAccount { @@ -44,17 +46,21 @@ export class StoreHost { constructor(private readonly options: StoreHostOptions) {} - async openAccount(params: OpenAccountParams): Promise { + /** Says whether the account's file was there: gone with a key still around, the browser cleared it. */ + async openAccount(params: OpenAccountParams): Promise<{ fileExisted: boolean }> { const existing = this.accounts.get(params.account); if (existing) { if (params.session) this.setSession(params.account, params.session); this.setAuth(params.account, params.auth); - existing.engine.setScope(params.scope); + if (params.scope) existing.engine.setScope(params.scope); if (params.invertedKeywordSort !== null) existing.engine.setInvertedKeywordSort(params.invertedKeywordSort); void existing.engine.requestSync(); - return; + return { fileExisted: true }; } - const db = await this.options.storage.open(params.file, params.keyHex); + let fileExisted = this.options.storage.files().includes(params.file); + // Nothing to sync with yet: no empty file, or the next open would take it for the real one. + if (!fileExisted && !params.session) throw new Error('No session for this account yet'); + const db = await this.openOrReplace(params, () => { fileExisted = false; }); const session = params.session ?? AccountEngine.storedSession(db); if (!session) { db.close(); @@ -85,6 +91,32 @@ export class StoreHost { account.engine.setOnline(this.online); this.accounts.set(params.account, account); void account.engine.requestSync(); + return { fileExisted }; + } + + /** A file this key can't read is lost for good, whatever happened to it, and everything in it can be fetched again. */ + private async openOrReplace(params: OpenAccountParams, onReplaced: () => void): Promise { + try { + return await this.options.storage.open(params.file, params.keyHex); + } catch (error) { + if ((error as Error)?.name !== 'StoreKeyError' || !params.session) throw error; + this.options.storage.remove(params.file); + onReplaced(); + return this.options.storage.open(params.file, params.keyHex); + } + } + + /** Deletes files no account has a key for. Nothing can read them. Files in use stay, whatever the list says. */ + sweepFiles(known: readonly string[]): number { + const keep = new Set(known); + for (const open of this.accounts.values()) keep.add(open.file); + let removed = 0; + for (const name of this.options.storage.files()) { + const file = name.replace(/-journal$/, ''); + if (keep.has(file)) continue; + if (this.options.storage.remove(file)) removed += 1; + } + return removed; } setAuth(account: string, auth: string | null): void { @@ -104,8 +136,7 @@ export class StoreHost { setScope(account: string, scope: Parameters[0]): void { const open = this.accounts.get(account); if (!open) return; - open.engine.setScope(scope); - void open.engine.requestSync(); + if (open.engine.setScope(scope)) void open.engine.requestSync(); } setInvertedKeywordSort(account: string, inverted: boolean): void { @@ -166,6 +197,12 @@ export class StoreHost { if (!open) throw accountClosed(); return open.engine.areaCall(name, callParams); } + case 'setScope': { + const { account, scope } = params as Parameters[0]; + if (!this.accounts.has(account)) throw accountClosed(); + this.setScope(account, scope); + return undefined; + } case 'removeAccount': { const { account, file } = params as Parameters[0]; return this.removeAccount(account, file); diff --git a/lib/store/worker/protocol.ts b/lib/store/worker/protocol.ts index eefd34f96..c20577d38 100644 --- a/lib/store/worker/protocol.ts +++ b/lib/store/worker/protocol.ts @@ -15,7 +15,8 @@ export interface OpenAccountParams { /** 32 bytes in hex. Only ever sent to this tab's own worker, never over the channel. */ keyHex: string; session: StoreSession | null; - scope: StoreScope; + /** Undefined while the page can't tell (no policy yet): the store keeps the last one. */ + scope?: StoreScope; /** Null when this tab's client hasn't probed it: the stored answer stays. */ invertedKeywordSort: boolean | null; /** The page's current Authorization header. */ @@ -33,6 +34,8 @@ export interface StoreRpc { area(params: { account: string; name: string; params: unknown }): unknown; /** Closes an account and deletes its file. The name holds no account data. */ removeAccount(params: { account: string; file: string }): boolean; + /** How far back to keep mail, and what else. Any tab may say, since a policy reaches every tab. */ + setScope(params: { account: string; scope: StoreScope }): void; } export interface StoreStatus { @@ -75,10 +78,10 @@ export type PageToWorker = | { kind: 'init'; clientId: string; moduleUrl: string } | { kind: 'open'; id: string; params: OpenAccountParams } | { kind: 'close-account'; id: string; account: string } + | { kind: 'sweep-files'; id: string; known: string[] } | { kind: 'set-auth'; account: string; auth: string | null } | { kind: 'set-inverted'; account: string; inverted: boolean } | { kind: 'set-session'; account: string; session: StoreSession } - | { kind: 'set-scope'; account: string; scope: StoreScope } | { kind: 'release'; id: string }; export type WorkerToPage = diff --git a/lib/store/worker/worker.ts b/lib/store/worker/worker.ts index 52e1c3688..d211fd622 100644 --- a/lib/store/worker/worker.ts +++ b/lib/store/worker/worker.ts @@ -110,8 +110,7 @@ scope.addEventListener('message', async (event) => { break; case 'open': try { - await requireHost().openAccount(message.params); - reply(message.id); + reply(message.id, await requireHost().openAccount(message.params)); } catch (error) { replyError(message.id, error); } @@ -124,15 +123,19 @@ scope.addEventListener('message', async (event) => { replyError(message.id, error); } break; + case 'sweep-files': + try { + reply(message.id, requireHost().sweepFiles(message.known)); + } catch (error) { + replyError(message.id, error); + } + break; case 'set-auth': host?.setAuth(message.account, message.auth); break; case 'set-session': host?.setSession(message.account, message.session); break; - case 'set-scope': - host?.setScope(message.account, message.scope); - break; case 'set-inverted': host?.setInvertedKeywordSort(message.account, message.inverted); break; From 22a2d9e3a6b7bccbf37cec6e451388a10c5a9a91 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 08:56:25 +0100 Subject: [PATCH 10/20] fix: keep subjects out of localStorage for accounts that keep mail encrypted --- .../__tests__/email-snapshot-account.test.ts | 49 +++++++++++++++++++ stores/__tests__/pro-tab-store.test.ts | 22 +++++++++ stores/email-store.ts | 19 ++++++- stores/pro-tab-store.ts | 22 ++++++++- 4 files changed, 110 insertions(+), 2 deletions(-) diff --git a/stores/__tests__/email-snapshot-account.test.ts b/stores/__tests__/email-snapshot-account.test.ts index a7d2c4e4f..0b31fc020 100644 --- a/stores/__tests__/email-snapshot-account.test.ts +++ b/stores/__tests__/email-snapshot-account.test.ts @@ -38,6 +38,55 @@ describe('email boot snapshot', { timeout: 30_000 }, () => { }); }); +// With the local store on, the mail is encrypted on the device, and subjects in +// localStorage would give it away. +describe('email boot snapshot with the local store on', { timeout: 30_000 }, () => { + const ROW = { id: 'e1', subject: 'Secret subject', mailboxIds: { inbox: true } }; + const SNAPSHOT = { v: 3, account: 'alice@mail.example', mailboxes: MAILBOXES, selectedMailbox: 'inbox', emails: [ROW] }; + + async function boot(enabled: string[]) { + persistSession('alice@mail.example'); + localStorage.setItem('email-snapshot', JSON.stringify(SNAPSHOT)); + localStorage.setItem('bulwark-offline-accounts', JSON.stringify(enabled)); + vi.resetModules(); + return (await import('@/stores/email-store')).useEmailStore; + } + + it('is removed at the start and not restored', async () => { + const store = await boot(['alice@mail.example']); + expect(localStorage.getItem('email-snapshot')).toBeNull(); + expect(store.getState().emails).toEqual([]); + }); + + it('still works for an account without it', async () => { + const store = await boot(['bob@mail.example']); + expect(localStorage.getItem('email-snapshot')).not.toBeNull(); + expect(store.getState().emails).toHaveLength(1); + }); + + it('is never written while it is on', async () => { + const store = await boot(['alice@mail.example']); + store.setState({ mailboxes: MAILBOXES as never, emails: [ROW] as never, selectedMailbox: 'inbox' }); + await new Promise((resolve) => setTimeout(resolve, 1100)); + expect(localStorage.getItem('email-snapshot')).toBeNull(); + }); + + it('is written without it, as the control', async () => { + const store = await boot([]); + store.setState({ emails: [{ ...ROW, id: 'e2' }] as never }); + await new Promise((resolve) => setTimeout(resolve, 1100)); + expect(localStorage.getItem('email-snapshot')).toContain('e2'); + }); + + it('goes the moment the user turns it on', async () => { + const store = await boot([]); + expect(store.getState().emails).toHaveLength(1); + const { useOfflineStore } = await import('@/lib/offline/state'); + useOfflineStore.setState({ enabled: ['alice@mail.example'] }); + expect(localStorage.getItem('email-snapshot')).toBeNull(); + }); +}); + // The snapshot keeps the last plain folder that was open; a session that // ended in a unified view left Trash there, and every visit to "/" opened it. describe('email boot snapshot folder', { timeout: 30_000 }, () => { diff --git a/stores/__tests__/pro-tab-store.test.ts b/stores/__tests__/pro-tab-store.test.ts index c473f08a3..6267629c5 100644 --- a/stores/__tests__/pro-tab-store.test.ts +++ b/stores/__tests__/pro-tab-store.test.ts @@ -1,4 +1,5 @@ import { beforeEach, describe, expect, it } from 'vitest'; +import { useOfflineStore } from '@/lib/offline/state'; import { useProTabStore, normalizeProTabState, @@ -507,3 +508,24 @@ describe('property: random operation sequences never violate the invariants', () } }); }); + +describe('stored tabs with the local store on', () => { + const stored = () => localStorage.getItem('pro-tabs') ?? ''; + const open = () => useProTabStore.getState().openEmailTab({ accountId: 'acc', emailId: 'm9', mailboxId: null, title: 'Secret subject' }); + + it('hold the subject without it', () => { + useOfflineStore.setState({ enabled: [] }); + open(); + expect(stored()).toContain('Secret subject'); + }); + + it('lose it the moment it is turned on, and the open tab keeps its title', () => { + useOfflineStore.setState({ enabled: [] }); + open(); + useOfflineStore.setState({ enabled: ['acc'] }); + expect(stored()).not.toContain('Secret subject'); + expect(stored()).toContain('m9'); + expect(useProTabStore.getState().tabs.some((tab) => tab.title === 'Secret subject')).toBe(true); + useOfflineStore.setState({ enabled: [] }); + }); +}); diff --git a/stores/email-store.ts b/stores/email-store.ts index 0f1b60161..a917bcfe0 100644 --- a/stores/email-store.ts +++ b/stores/email-store.ts @@ -38,6 +38,7 @@ import { SendCancelledCleanupError } from "@/lib/send-failure-message"; import type { StorageQuota } from "@/lib/quota"; import { isArchiveActionEnabled } from "@/lib/archive-gate"; import { getOutboxHooks } from "@/lib/offline/outbox-hooks"; +import { useOfflineStore } from "@/lib/offline/state"; import { READ_FILTER, UNREAD_FILTER, UNREAD_SECTION_SIZE, andFilters, isUnreadFirstView, mergeUnreadSection, openSectionRows, sectionFromUnreadRows, unreadSectionRowCount, withoutReached, type UnreadSection, @@ -8629,6 +8630,15 @@ const EMAIL_SNAPSHOT_KEY = 'email-snapshot'; const EMAIL_SNAPSHOT_VERSION = 3; const EMAIL_SNAPSHOT_MAX_EMAILS = 50; +/** + * With the local store on, the mail is encrypted on this device, and a copy of + * subjects in localStorage would give that away. The store paints the list at + * start itself (startLocalCopyClient), so the snapshot isn't needed there. + */ +function keptEncrypted(account: unknown): boolean { + return typeof account === 'string' && useOfflineStore.getState().enabled.includes(account); +} + function isEmailListSync(value: unknown, mailboxId: string): value is EmailListSync { const sync = value as EmailListSync | null; return !!sync && typeof sync.state === 'string' && typeof sync.accountId === 'string' && sync.mailboxId === mailboxId; @@ -8651,6 +8661,7 @@ if (typeof window !== 'undefined') { try { const auth = persistedAuthState(); const authed = auth?.isAuthenticated === true; + if (keptEncrypted(auth?.activeAccountId)) window.localStorage.removeItem(EMAIL_SNAPSHOT_KEY); const raw = authed ? window.localStorage.getItem(EMAIL_SNAPSHOT_KEY) : null; if (raw) { const snap = JSON.parse(raw); @@ -8698,6 +8709,12 @@ if (typeof window !== 'undefined') { } catch { /* corrupt snapshot - start empty */ } let snapshotTimer: ReturnType | null = null; + // Turned on just now: what's there goes at once. + useOfflineStore.subscribe((state, prev) => { + if (state.enabled === prev.enabled || !keptEncrypted(persistedAuthState()?.activeAccountId)) return; + if (snapshotTimer) { clearTimeout(snapshotTimer); snapshotTimer = null; } + try { window.localStorage.removeItem(EMAIL_SNAPSHOT_KEY); } catch { /* ignore */ } + }); useEmailStore.subscribe((state, prev) => { if ( state.emails === prev.emails && @@ -8727,7 +8744,7 @@ if (typeof window !== 'undefined') { // would be read as the active account's mail. (#847) if (s.searchQuery || s.selectedKeyword || s.isScheduledView || s.viewingAccountId || s.isUnifiedView) return; const account = persistedAuthState()?.activeAccountId; - if (typeof account !== 'string' || !account) return; + if (typeof account !== 'string' || !account || keptEncrypted(account)) return; try { window.localStorage.setItem(EMAIL_SNAPSHOT_KEY, JSON.stringify({ v: EMAIL_SNAPSHOT_VERSION, diff --git a/stores/pro-tab-store.ts b/stores/pro-tab-store.ts index 36051d2a8..c3f90fa99 100644 --- a/stores/pro-tab-store.ts +++ b/stores/pro-tab-store.ts @@ -4,6 +4,7 @@ import type { ComposerDraftData } from '@/components/email/email-composer'; import type { ComposePrefill } from '@/lib/plugin-compose-gate'; import type { EmailWriteSource } from '@/stores/email-store'; import type { SearchScope } from '@/lib/global-search/query-parser'; +import { useOfflineStore } from '@/lib/offline/state'; export type ProTabKind = | 'mail' | 'calendar' | 'contacts' | 'files' | 'settings' @@ -122,6 +123,20 @@ export interface ProTab { paneId: ProPaneId; } +/** + * With the local store on, mail is encrypted on this device, and a subject in + * localStorage would give it away. The tab's body puts the title back when it + * has read the message. + */ +const TITLE_UNTIL_LOADED = '…'; + +function withoutSubjects(tabs: ProTab[]): ProTab[] { + if (useOfflineStore.getState().enabled.length === 0) return tabs; + return tabs.map((tab) => (tab.kind === 'email' && tab.emailData + ? { ...tab, title: TITLE_UNTIL_LOADED, emailData: { ...tab.emailData, title: TITLE_UNTIL_LOADED } } + : tab)); +} + export interface OpenEmailTabOptions { /** * Force the tab into a specific pane. Passing 'split' when no split exists @@ -695,7 +710,7 @@ export const useProTabStore = create()( // own draft-store already handles that. Persisted email tabs are fine to // restore (the tab body refetches the email by id). partialize: (state) => ({ - tabs: state.tabs.filter((tab) => tab.kind !== 'compose'), + tabs: withoutSubjects(state.tabs.filter((tab) => tab.kind !== 'compose')), activeTabId: state.activeTabId, activeSplitTabId: state.activeSplitTabId, focusedPaneId: state.focusedPaneId, @@ -742,3 +757,8 @@ export const useProTabStore = create()( }, ), ); + +// Turned on just now: the stored copy loses its subjects at once, not at the next tab change. +useOfflineStore.subscribe((state, prev) => { + if (state.enabled !== prev.enabled && state.enabled.length > 0) useProTabStore.setState({}); +}); From b001cbf109ce7ca2aa82e4f1d00c91622a21e79d Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 08:57:41 +0100 Subject: [PATCH 11/20] feat: show what each account keeps on the device and let it be changed and cleared The offline section of Settings > Backup & reset now shows, per account, the space each part takes, the last sync, a first sync's progress with the time left, the window and attachment choices, and clearing the account. All conflicts, calendar and contacts too, are listed there and counted in the banner. - the organisation's caps beat the user's choice and the desktop default, and every path that takes a scope goes through `effectiveScope` - the desktop app keeps mail without asking, says so once, and stays off for an account where the user turned it off - `navigator.storage.persist()` is asked on turning it on, and a refusal warns with a way to ask again; Safari gets the 7-day hint when not installed - a store the browser deleted is noticed, says what was lost and syncs again - a full disk says so, with what to do - those who had offline mode keep it, with the 30 days they had - Keep offline in the Files app's menu --- .../admin/org/sections/offline-section.tsx | 2 +- components/files/file-browser.tsx | 12 +- .../__tests__/account-storage.test.tsx | 251 ++++++++++++++ components/offline/account-storage.tsx | 205 +++++++++++ components/offline/kept-files.tsx | 32 ++ components/offline/offline-banner.tsx | 2 +- components/offline/offline-host.tsx | 21 +- components/offline/offline-settings.tsx | 106 +++--- components/offline/outbox-list.tsx | 29 +- hooks/use-keep-file-offline.ts | 39 +++ hooks/use-kept-files.ts | 58 ++++ lib/__tests__/sign-out-cleanup.test.ts | 1 + .../__tests__/effective-scope-wiring.test.ts | 216 ++++++++++++ lib/offline/__tests__/migrate-legacy.test.ts | 24 +- lib/offline/__tests__/scope.test.ts | 122 +++++++ lib/offline/__tests__/storage-health.test.ts | 326 ++++++++++++++++++ lib/offline/__tests__/sync-progress.test.ts | 50 +++ lib/offline/migrate-legacy.ts | 5 +- lib/offline/offline-mode.ts | 274 +++++++++++++-- lib/offline/queue.ts | 3 +- lib/offline/scope.ts | 125 +++++++ lib/offline/state.ts | 117 +++++++ lib/offline/storage-health.ts | 60 ++++ lib/offline/sync-progress.ts | 60 ++++ lib/sign-out-cleanup.ts | 3 + locales/ar/common.json | 55 +++ locales/ca/common.json | 55 +++ locales/cs/common.json | 55 +++ locales/da/common.json | 55 +++ locales/de/common.json | 55 +++ locales/en/common.json | 55 +++ locales/es/common.json | 55 +++ locales/et/common.json | 55 +++ locales/fa/common.json | 55 +++ locales/fr/common.json | 55 +++ locales/he/common.json | 55 +++ locales/hu/common.json | 55 +++ locales/it/common.json | 55 +++ locales/ja/common.json | 55 +++ locales/ko/common.json | 55 +++ locales/lv/common.json | 55 +++ locales/mn/common.json | 55 +++ locales/nb/common.json | 55 +++ locales/nl/common.json | 55 +++ locales/pl/common.json | 55 +++ locales/pt/common.json | 55 +++ locales/ro/common.json | 55 +++ locales/ru/common.json | 55 +++ locales/sk/common.json | 55 +++ locales/th/common.json | 55 +++ locales/tr/common.json | 55 +++ locales/uk/common.json | 55 +++ locales/vi/common.json | 55 +++ locales/zh-TW/common.json | 55 +++ locales/zh/common.json | 55 +++ 55 files changed, 3701 insertions(+), 92 deletions(-) create mode 100644 components/offline/__tests__/account-storage.test.tsx create mode 100644 components/offline/account-storage.tsx create mode 100644 components/offline/kept-files.tsx create mode 100644 hooks/use-keep-file-offline.ts create mode 100644 hooks/use-kept-files.ts create mode 100644 lib/offline/__tests__/effective-scope-wiring.test.ts create mode 100644 lib/offline/__tests__/scope.test.ts create mode 100644 lib/offline/__tests__/storage-health.test.ts create mode 100644 lib/offline/__tests__/sync-progress.test.ts create mode 100644 lib/offline/scope.ts create mode 100644 lib/offline/storage-health.ts create mode 100644 lib/offline/sync-progress.ts diff --git a/components/admin/org/sections/offline-section.tsx b/components/admin/org/sections/offline-section.tsx index 9494654ca..5c05dda77 100644 --- a/components/admin/org/sections/offline-section.tsx +++ b/components/admin/org/sections/offline-section.tsx @@ -25,7 +25,7 @@ const CAP_FIELDS: CapField[] = [ { key: 'offlineMaxAttachmentMb', label: 'Largest attachment or file kept', - description: 'Anything bigger is removed from the device and opened from the server when there is a connection.', + description: 'Anything bigger leaves the device and opens from the server when there is a connection. Files someone chose to keep offline count only towards the total below.', unit: 'MB', max: 1024 * 1024, }, diff --git a/components/files/file-browser.tsx b/components/files/file-browser.tsx index 37d375816..d8bbc9683 100644 --- a/components/files/file-browser.tsx +++ b/components/files/file-browser.tsx @@ -3,12 +3,13 @@ import { useState, useCallback, useRef, useEffect, useMemo } from "react"; import { useTranslations } from "next-intl"; import { - Upload, FolderPlus, Download, Trash2, Pencil, Copy, Clipboard, Scissors, Info, + Upload, FolderPlus, Download, Trash2, Pencil, Copy, Clipboard, Scissors, Info, Pin, PinOff, FilePlus, CopyPlus, AlertCircle, FolderUp, Share2, SquarePen, Eye, FolderOpen, RefreshCw, Star, StarOff, Plus, CheckSquare, File, RotateCcw, FolderInput, } from "@/components/icons"; import { useIsDesktop, useIsMobile, useMediaQuery } from "@/hooks/use-media-query"; import { useContextMenu } from "@/hooks/use-context-menu"; +import { useKeepFileOffline } from "@/hooks/use-keep-file-offline"; import { useRegisterCommands } from "@/lib/command-registry"; import { formatShortcutCombo } from "@/lib/shortcut-keys"; import { Button } from "@/components/ui/button"; @@ -319,6 +320,8 @@ export function FileBrowser({ const dragDepth = useRef(0); const anchorName = useRef(null); const menu = useContextMenu(); + const tOffline = useTranslations("offlineStorage"); + const { keptOffline, canKeepOffline, toggleKeptOffline } = useKeepFileOffline(client); const fileInputRef = useRef(null); const folderInputRef = useRef(null); const searchInputRef = useRef(null); @@ -939,6 +942,13 @@ export function FileBrowser({ )} )} + {canKeepOffline(resource) && ( + { closeMenu(); void toggleKeptOffline(resource); }} + /> + )} {(canShare(resource) || (resource.isDirectory && !resource.isShared)) && } {canShare(resource) && ( { closeMenu(); setShareTargetId(resource.id); }} /> diff --git a/components/offline/__tests__/account-storage.test.tsx b/components/offline/__tests__/account-storage.test.tsx new file mode 100644 index 000000000..1e0aeb682 --- /dev/null +++ b/components/offline/__tests__/account-storage.test.tsx @@ -0,0 +1,251 @@ +import 'fake-indexeddb/auto'; +import { act, fireEvent, render, screen, waitFor, within } from '@testing-library/react'; +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; + +const offline = vi.hoisted(() => ({ + clearAccount: vi.fn(async () => {}), + chooseScope: vi.fn(), + requestPersistence: vi.fn(async () => 'refused'), + dismissAreaConflict: vi.fn(async () => {}), +})); +vi.mock('@/lib/offline/offline-mode', async (importOriginal) => ({ + ...(await importOriginal()), + clearAccount: offline.clearAccount, + chooseScope: offline.chooseScope, + requestPersistence: offline.requestPersistence, + dismissAreaConflict: offline.dismissAreaConflict, + readPersistence: vi.fn(async () => 'refused'), + refreshUsage: vi.fn(async () => {}), +})); + +import { OfflineSettings } from '../offline-settings'; +import { OfflineBanner } from '../offline-banner'; +import { useOfflineStore } from '@/lib/offline/state'; +import { useAuthStore } from '@/stores/auth-store'; +import { usePolicyStore } from '@/stores/policy-store'; +import { DEFAULT_ORGANISATION_POLICY } from '@/lib/admin/organisation-policy'; +import { setStoreBackend, type StoreBackend } from '@/lib/store/client/api'; +import { fileRefFor } from '@/hooks/use-keep-file-offline'; + +const area = vi.fn(async (_account: string, name: string) => (name === 'files.kept' ? { + files: [ + { jmap: 'j', id: 'f1', name: 'Pinned.pdf', size: 2048, pinned: true, kept: true, error: null }, + { jmap: 'j', id: 'f2', name: 'Big.iso', size: 1048576, pinned: true, kept: false, error: 'overLimit' }, + { jmap: 'j', id: 'f3', name: 'Opened.txt', size: 5, pinned: false, kept: true, error: null }, + ], +} : null)); + +function setDevices(devices: Partial) { + usePolicyStore.setState({ + loaded: true, source: 'server', subject: null, + policy: { ...usePolicyStore.getState().policy, organisation: { ...DEFAULT_ORGANISATION_POLICY, devices: { ...DEFAULT_ORGANISATION_POLICY.devices, ...devices } } }, + } as never); +} + +beforeEach(() => { + localStorage.clear(); + vi.clearAllMocks(); + setStoreBackend({ supported: () => true, area, setScope: vi.fn(async () => {}) } as unknown as StoreBackend); + useAuthStore.setState({ activeAccountId: 'acc', getAllConnectedClients: (() => new Map()) as never }); + useOfflineStore.setState({ + enabled: ['acc'], outbox: [], pendingChanges: 0, conflicts: [], areaConflicts: [], syncing: [], lastSyncedAt: {}, choices: { acc: { on: true } }, health: {}, + storageFull: {}, progress: {}, persist: 'granted', browserOffline: false, downServers: [], startedOffline: false, + usage: { acc: { bytes: 5000, parts: [{ part: 'mail', bytes: 4000, items: 12 }, { part: 'attachments', bytes: 1000, items: 2 }] } }, + }); + setDevices({}); +}); + +afterEach(() => { setStoreBackend(null); }); + +const windowSelect = () => screen.getByText('window_label').closest('[data-search-label]')!.querySelector('select') as HTMLSelectElement; + +describe('what an account keeps', () => { + it('offers every window and hands the choice on', () => { + render(); + expect([...windowSelect().options].map((o) => o.value)).toEqual(['30', '90', '365', 'all']); + expect(windowSelect().value).toBe('90'); + fireEvent.change(windowSelect(), { target: { value: 'all' } }); + expect(offline.chooseScope).toHaveBeenCalledWith('acc', { days: null }); + }); + + it('under a cap offers only what fits, and says who set it', () => { + setDevices({ offlineMaxDays: 60 }); + render(); + expect([...windowSelect().options].map((o) => o.value)).toEqual(['30', '60']); + expect(windowSelect().value).toBe('60'); + expect(within(screen.getByText('window_label').closest('[data-search-label]') as HTMLElement).getByText('org_locked')).toBeInTheDocument(); + }); + + it('locks the window when the cap leaves no choice', () => { + setDevices({ offlineMaxDays: 14 }); + render(); + const row = screen.getByText('window_label').closest('[data-search-label]') as HTMLElement; + expect(windowSelect().parentElement?.closest('[inert]')).not.toBeNull(); + expect(within(row).getByText('org_locked')).toBeInTheDocument(); + }); + + it('locks attachments off when the organisation forbids them, and hides the size', () => { + useOfflineStore.setState({ choices: { acc: { on: true, attachments: true } } }); + setDevices({ noOfflineAttachments: true }); + render(); + const toggle = screen.getByTestId('offline-attachments'); + expect(toggle.getAttribute('aria-checked')).toBe('false'); + expect(toggle.closest('[inert]')).not.toBeNull(); + expect(screen.queryByText('attachment_cap_label')).toBeNull(); + fireEvent.click(toggle); + }); + + it('caps the size choice', () => { + setDevices({ offlineMaxAttachmentMb: 10 }); + render(); + const select = screen.getByText('attachment_cap_label').closest('[data-search-label]')!.querySelector('select') as HTMLSelectElement; + expect([...select.options].map((o) => o.value)).toEqual(['5', '10']); + fireEvent.change(select, { target: { value: '5' } }); + expect(offline.chooseScope).toHaveBeenCalledWith('acc', { maxAttachmentMb: 5 }); + }); + + it('says when the total is set by the organisation', () => { + setDevices({ offlineMaxTotalMb: 100 }); + render(); + expect(screen.getByTestId('offline-total-locked').textContent).toContain('total_locked'); + }); + + it('shows nothing of this with offline off', () => { + useOfflineStore.setState({ enabled: [] }); + render(); + expect(screen.queryByText('window_label')).toBeNull(); + expect(screen.queryByTestId('offline-clear')).toBeNull(); + }); +}); + +describe('what it takes', () => { + it('lists each part', () => { + render(); + const usage = screen.getByTestId('offline-usage'); + expect(usage.textContent).toContain('usage_mail'); + expect(usage.textContent).toContain('usage_attachments'); + expect(screen.getByTestId('offline-status').textContent).toContain('usage'); + }); + + it('shows the time of the last sync from before a reload', () => { + useOfflineStore.setState({ health: { acc: { opened: true, lastSync: Date.now() - 60_000 } } }); + render(); + expect(screen.getByTestId('offline-status').textContent).toContain('usage_updated'); + }); + + it('shows a large sync going on, with the time left once it can tell', () => { + const now = Date.now(); + useOfflineStore.setState({ + syncing: ['acc'], + progress: { acc: { area: 'mail', phase: 'bodies', done: 500, total: 5000, startedAt: now - 60_000, startedDone: 0, at: now } }, + }); + render(); + const line = screen.getByTestId('offline-progress'); + expect(line.textContent).toContain('progress_bodies'); + expect(line.textContent).toContain('progress_count'); + expect(line.textContent).toContain('progress_left'); + expect(line.querySelector('progress')?.getAttribute('max')).toBe('5000'); + }); + + it('keeps a small catch-up quiet', () => { + const now = Date.now(); + useOfflineStore.setState({ syncing: ['acc'], progress: { acc: { area: 'mail', phase: 'bodies', done: 1, total: 3, startedAt: now, startedDone: 0, at: now } } }); + render(); + expect(screen.queryByTestId('offline-progress')).toBeNull(); + }); +}); + +describe('clearing an account', () => { + it('asks first, naming unsent mail', () => { + useOfflineStore.setState({ outbox: [{ id: 1, account: 'acc', createdAt: 1, subject: 'Hi', to: [], status: 'waiting' }] }); + render(); + fireEvent.click(screen.getByTestId('offline-clear')); + expect(offline.clearAccount).not.toHaveBeenCalled(); + expect(screen.getByText(/clear_confirm_unsent/)).toBeInTheDocument(); + fireEvent.click(screen.getByRole('button', { name: 'clear_confirm' })); + expect(offline.clearAccount).toHaveBeenCalledWith('acc'); + }); +}); + +describe('what the browser may do', () => { + it('warns when it refused to keep the data, and can ask again', async () => { + useOfflineStore.setState({ persist: 'refused' }); + render(); + expect(screen.getByTestId('offline-persist-refused').textContent).toContain('persist_refused'); + await act(async () => { fireEvent.click(screen.getByTestId('offline-persist-retry')); }); + expect(offline.requestPersistence).toHaveBeenCalled(); + }); + + it('says nothing when it agreed', () => { + render(); + expect(screen.queryByTestId('offline-persist-refused')).toBeNull(); + }); + + it('warns about a store it deleted, with the count, until read', () => { + useOfflineStore.setState({ health: { acc: { opened: true, evicted: { at: 1, lost: 2 } } } }); + render(); + expect(screen.getByTestId('offline-evicted').textContent).toContain('evicted_lost'); + fireEvent.click(within(screen.getByTestId('offline-evicted')).getByRole('button', { name: 'evicted_dismiss' })); + expect(useOfflineStore.getState().health.acc.evicted).toBeUndefined(); + }); + + it('says the device is full, with what to do', () => { + useOfflineStore.setState({ storageFull: { acc: 1 } }); + render(); + const alert = screen.getByTestId('offline-storage-full'); + expect(alert.textContent).toContain('storage_full_title'); + fireEvent.click(within(alert).getByRole('button', { name: 'clear_button' })); + expect(screen.getByRole('button', { name: 'clear_confirm' })).toBeInTheDocument(); + }); + + it('gives the Safari hint only in Safari', () => { + const real = window.navigator.userAgent; + render(); + expect(screen.queryByTestId('offline-safari-hint')).toBeNull(); + Object.defineProperty(window.navigator, 'userAgent', { configurable: true, value: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14_5) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.5 Safari/605.1.15' }); + render(); + expect(screen.getByTestId('offline-safari-hint')).toBeInTheDocument(); + Object.defineProperty(window.navigator, 'userAgent', { configurable: true, value: real }); + }); +}); + +describe('everything that did not go through', () => { + const conflicts = [ + { area: 'calendar', account: 'acc', id: 1, createdAt: 1, title: 'Team meeting', reason: 'changed', destroy: false, detail: null }, + { area: 'contacts', account: 'acc', id: 2, createdAt: 1, title: 'Ana Silva', reason: 'refused', destroy: false, detail: 'Nope' }, + ] as const; + + it('lists calendar and contacts next to mail, and each can be dismissed', async () => { + useOfflineStore.setState({ areaConflicts: [...conflicts] }); + render(); + const rows = screen.getAllByTestId('offline-conflict-row'); + expect(rows.map((row) => row.getAttribute('data-area'))).toEqual(['calendar', 'contacts']); + expect(rows[0].textContent).toContain('Team meeting'); + fireEvent.click(within(rows[1]).getByRole('button', { name: 'dismiss_label' })); + await waitFor(() => expect(offline.dismissAreaConflict).toHaveBeenCalledWith(conflicts[1])); + }); + + it('counts them all in the banner', () => { + useOfflineStore.setState({ areaConflicts: [...conflicts] }); + render(); + expect(screen.getByTestId('offline-banner-conflicts')).toBeInTheDocument(); + }); +}); + +describe('files kept offline', () => { + it('lists the pinned ones with their state, and can let go of one', async () => { + render(); + const rows = await screen.findAllByTestId('offline-kept-file'); + expect(rows).toHaveLength(2); + expect(rows[0].textContent).toContain('kept_state_kept'); + expect(rows[1].textContent).toContain('kept_error_overLimit'); + expect(screen.queryByText('Opened.txt')).toBeNull(); + fireEvent.click(within(rows[0]).getByRole('button', { name: 'unpin_label' })); + await waitFor(() => expect(area).toHaveBeenCalledWith('acc', 'files.unpin', expect.objectContaining({ jmap: 'j', id: 'f1' }))); + }); + + it('a node of another account goes by that account', () => { + expect(fileRefFor('shared1:n7', 'own')).toEqual({ jmap: 'shared1', id: 'n7' }); + expect(fileRefFor('n7', 'own')).toEqual({ jmap: 'own', id: 'n7' }); + }); +}); diff --git a/components/offline/account-storage.tsx b/components/offline/account-storage.tsx new file mode 100644 index 000000000..e3ebf9c73 --- /dev/null +++ b/components/offline/account-storage.tsx @@ -0,0 +1,205 @@ +'use client'; + +import { useEffect, useState } from 'react'; +import { useFormatter, useTranslations } from 'next-intl'; +import { Lock } from '@/components/icons'; +import { SettingItem, Select, ToggleSwitch } from '@/components/settings/settings-section'; +import { OrgLockedNote } from '@/components/settings/org-locked-note'; +import { Button } from '@/components/ui/button'; +import { ConfirmDialog } from '@/components/ui/confirm-dialog'; +import { formatFileSize } from '@/lib/utils'; +import { chooseScope, clearAccount, disableOffline, dismissEvicted, enableOffline, scopeForAccount } from '@/lib/offline/offline-mode'; +import { attachmentCapOptions, maxAttachmentMb, windowOptions } from '@/lib/offline/scope'; +import { useOfflineStore } from '@/lib/offline/state'; +import { minutesLeft, progressWorthShowing, type SyncProgress } from '@/lib/offline/sync-progress'; +import { devicesForAccount } from '@/lib/device-policy'; +import { KeptFiles } from './kept-files'; + +const MB = 1024 * 1024; +const ALL = 'all'; + +function ProgressLine({ progress }: { progress: SyncProgress }) { + const t = useTranslations('offlineStorage'); + const format = useFormatter(); + const phase = progress.phase === 'list' ? t('progress_list') + : progress.phase === 'bodies' ? t('progress_bodies') + : progress.phase === 'threads' ? t('progress_threads') + : progress.area === 'files' ? t('progress_files') + : t('progress_other'); + const left = minutesLeft(progress); + const count = progress.total === null + ? t('progress_count_open', { done: format.number(progress.done) }) + : t('progress_count', { done: format.number(progress.done), total: format.number(progress.total) }); + return ( +

+

+ {phase}: {count}{left !== null && <> · {t('progress_left', { minutes: left })}} +

+ {progress.total !== null && progress.total > 0 && ( + + )} +
+ ); +} + +/** One account in Settings > Backup & reset > Offline. */ +export function AccountStorage({ account, primary, heading }: { account: string; primary: boolean; heading: string | null }) { + const t = useTranslations('offline.settings'); + const tStorage = useTranslations('offlineStorage'); + const format = useFormatter(); + const enabled = useOfflineStore((s) => s.enabled.includes(account)); + const usage = useOfflineStore((s) => s.usage[account]); + const syncing = useOfflineStore((s) => s.syncing.includes(account)); + const lastSynced = useOfflineStore((s) => s.lastSyncedAt[account] ?? s.health[account]?.lastSync); + const evicted = useOfflineStore((s) => s.health[account]?.evicted); + const storageFull = useOfflineStore((s) => !!s.storageFull[account]); + const progress = useOfflineStore((s) => s.progress[account]); + const unsent = useOfflineStore((s) => s.outbox.filter((row) => row.account === account).length); + // Re-renders on a choice; the value itself is worked out below, with the policy. + useOfflineStore((s) => s.choices[account]); + const [confirmOff, setConfirmOff] = useState(false); + const [confirmClear, setConfirmClear] = useState(false); + const devices = devicesForAccount(account); + const { scope, locked } = scopeForAccount(account); + const [now, setNow] = useState(() => Date.now()); + useEffect(() => { setNow(Date.now()); }, [lastSynced, syncing]); + + const testId = (id: string) => (primary ? id : `${id}-other`); + + if (locked.offline) { + return ( +
+ {heading &&

{heading}

} +

{t('keep_label')}

+

{t('forbidden')}

+ +
+ ); + } + + const windows = windowOptions(devices.offlineMaxDays); + const windowLabel = (days: number | null) => { + if (days === null) return tStorage('window_everything'); + if (days === 365) return tStorage('window_year'); + return tStorage('window_days', { days }); + }; + const caps = attachmentCapOptions(devices.offlineMaxAttachmentMb); + const currentCap = maxAttachmentMb(scope); + + return ( +
+ {heading &&

{heading}

} + + { + if (on) void enableOffline(account); + else if (unsent > 0) setConfirmOff(true); + else void disableOffline(account); + }} + /> + + {evicted && ( +
+

+ {tStorage('evicted')} + {evicted.lost > 0 && <> {tStorage('evicted_lost', { count: evicted.lost })}} +

+ +
+ )} + {enabled && ( + <> + {storageFull && ( +
+

{tStorage('storage_full_title')} {tStorage('storage_full_text')}

+ +
+ )} +
+

+ {syncing + ? t('syncing') + : lastSynced + ? t('usage_updated', { size: formatFileSize(usage?.bytes ?? 0), time: format.relativeTime(lastSynced, now) }) + : t('usage', { size: formatFileSize(usage?.bytes ?? 0) })} +

+ {syncing && progressWorthShowing(progress) && } + {usage && usage.parts.length > 0 && ( +
+ {usage.parts.map((part) => ( +
+
{tStorage(`usage_${part.part}`)}
+
{tStorage('usage_row', { size: formatFileSize(part.bytes), count: part.items })}
+
+ ))} +
+ )} +
+ +
+ chooseScope(account, { maxAttachmentMb: Number(value) })} + options={(caps.includes(currentCap) ? caps : [...caps, currentCap].sort((a, b) => a - b)).map((mb) => ({ value: String(mb), label: formatFileSize(mb * MB) }))} + /> + {locked.maxAttachment && caps.length > 1 && } +
+ + )} + + + + + + )} + setConfirmOff(false)} + onConfirm={() => { setConfirmOff(false); void disableOffline(account); }} + title={t('off_confirm_title')} + message={t('off_confirm_message', { count: unsent })} + confirmText={t('off_confirm')} + variant="destructive" + /> + setConfirmClear(false)} + onConfirm={() => { setConfirmClear(false); void clearAccount(account); }} + title={tStorage('clear_confirm_title')} + message={unsent > 0 ? `${tStorage('clear_confirm_message')} ${tStorage('clear_confirm_unsent', { count: unsent })}` : tStorage('clear_confirm_message')} + confirmText={tStorage('clear_confirm')} + variant="destructive" + /> +
+ ); +} diff --git a/components/offline/kept-files.tsx b/components/offline/kept-files.tsx new file mode 100644 index 000000000..f38bf9059 --- /dev/null +++ b/components/offline/kept-files.tsx @@ -0,0 +1,32 @@ +'use client'; + +import { useTranslations } from 'next-intl'; +import { Button } from '@/components/ui/button'; +import { formatFileSize } from '@/lib/utils'; +import { useKeptFiles } from '@/hooks/use-kept-files'; + +/** The files this account keeps until told otherwise, in Settings > Backup & reset > Offline. */ +export function KeptFiles({ account }: { account: string }) { + const t = useTranslations('offlineStorage'); + const { pinned, unpin } = useKeptFiles(account); + if (pinned.length === 0) return null; + return ( +
+

{t('kept_files_title')}

+
    + {pinned.map((file) => ( +
  • +
    +

    {file.name}

    +

    + {file.size !== null && <>{formatFileSize(file.size)} · } + {file.kept ? t('kept_state_kept') : file.error ? t(`kept_error_${file.error}` as 'kept_error_download') : t('kept_state_waiting')} +

    +
    + +
    • + ))} +
+
+ ); +} diff --git a/components/offline/offline-banner.tsx b/components/offline/offline-banner.tsx index dc179e362..2174bfb43 100644 --- a/components/offline/offline-banner.tsx +++ b/components/offline/offline-banner.tsx @@ -24,7 +24,7 @@ export function OfflineBanner() { const browserOffline = useOfflineStore((s) => s.browserOffline || s.startedOffline); const serverDown = useOfflineStore((s) => !!server && s.downServers.includes(serverKey(server))); const waiting = useOfflineStore((s) => s.outbox.length); - const conflicts = useOfflineStore((s) => s.conflicts.length); + const conflicts = useOfflineStore((s) => s.conflicts.length + s.areaConflicts.length); const tConflicts = useTranslations('offlineConflicts'); const [open, setOpen] = useState(false); const offline = browserOffline || serverDown; diff --git a/components/offline/offline-host.tsx b/components/offline/offline-host.tsx index 13e675950..b7657ce4d 100644 --- a/components/offline/offline-host.tsx +++ b/components/offline/offline-host.tsx @@ -2,10 +2,12 @@ import { useEffect, useRef } from 'react'; import { useTranslations } from 'next-intl'; +import { useRouter } from '@/i18n/navigation'; import { ConfirmDialog } from '@/components/ui/confirm-dialog'; import { useConfirmDialog } from '@/hooks/use-confirm-dialog'; import { addSignOutGate } from '@/lib/sign-out-cleanup'; import { reloadToNewBuild } from '@/lib/app-update'; +import { buildSettingsPath } from '@/lib/deep-links'; import { confirmLoss, setOfflineNotifier, startOfflineMode, type OfflineNotice } from '@/lib/offline/offline-mode'; import { useOfflineStore } from '@/lib/offline/state'; import { toast } from '@/stores/toast-store'; @@ -23,6 +25,12 @@ export function OfflineHost() { const tConflicts = useTranslations('offlineConflicts'); const tConflictsRef = useRef(tConflicts); tConflictsRef.current = tConflicts; + const tStorage = useTranslations('offlineStorage'); + const tStorageRef = useRef(tStorage); + tStorageRef.current = tStorage; + const router = useRouter(); + const routerRef = useRef(router); + routerRef.current = router; const { dialogProps, confirm } = useConfirmDialog(); const confirmRef = useRef(confirm); confirmRef.current = confirm; @@ -30,6 +38,7 @@ export function OfflineHost() { useEffect(() => { const show = (notice: OfflineNotice) => { const tr = tRef.current; + const openStorage = { label: tStorageRef.current('open_settings'), onClick: () => routerRef.current.push(buildSettingsPath('backup', 'offline')) }; switch (notice.kind) { case 'queued': toast.info(tr('toast.queued')); @@ -52,7 +61,17 @@ export function OfflineHost() { toast.warning(tConflictsRef.current('toast', { count: notice.count })); break; case 'storage-failed': - toast.warning(tConflictsRef.current('storage_failed'), { duration: 0 }); + toast.warning(tStorageRef.current('storage_full_title'), { message: tStorageRef.current('storage_full_text'), duration: 0, action: openStorage }); + break; + case 'evicted': + toast.warning(tStorageRef.current('evicted'), { + message: notice.lost > 0 ? tStorageRef.current('evicted_lost', { count: notice.lost }) : undefined, + duration: notice.lost > 0 ? 0 : undefined, + action: openStorage, + }); + break; + case 'default-on': + toast.info(tStorageRef.current('default_on'), { duration: 0, action: openStorage }); break; case 'refused-delete': toast.warning(tr('toast.refused_delete')); diff --git a/components/offline/offline-settings.tsx b/components/offline/offline-settings.tsx index 013e37ecb..6205828d0 100644 --- a/components/offline/offline-settings.tsx +++ b/components/offline/offline-settings.tsx @@ -1,94 +1,84 @@ 'use client'; -import { useState } from 'react'; -import { useFormatter, useTranslations } from 'next-intl'; +import { useEffect, useState } from 'react'; +import { useTranslations } from 'next-intl'; import { AlertTriangle } from '@/components/icons'; -import { SettingItem, SettingsSection, ToggleSwitch } from '@/components/settings/settings-section'; -import { OrgLockedNote } from '@/components/settings/org-locked-note'; -import { ConfirmDialog } from '@/components/ui/confirm-dialog'; +import { SettingsSection } from '@/components/settings/settings-section'; +import { Button } from '@/components/ui/button'; import { IS_LITE } from '@/lib/lite'; -import { formatFileSize } from '@/lib/utils'; -import { disableOffline, enableOffline, offlineAllowed, offlineSupported } from '@/lib/offline/offline-mode'; +import { signedInAccountIds } from '@/lib/device-policy'; +import { offlineSupported, readPersistence, refreshUsage, requestPersistence, safariMayDelete } from '@/lib/offline/offline-mode'; import { useOfflineStore } from '@/lib/offline/state'; import { useDevicePolicy } from '@/hooks/use-device-policy'; +import { useAccountStore } from '@/stores/account-store'; import { useAuthStore } from '@/stores/auth-store'; +import { AccountStorage } from './account-storage'; import { OutboxList } from './outbox-list'; /** - * Settings > Backup & reset > Offline (#523): "Keep mail on this device" - * for the active account, the space it uses, and the outbox. Not in Lite. - * When the organisation forbids it, the switch is gone and a note says so. + * Settings > Backup & reset > Offline (#523): for each account signed in here, + * whether it keeps mail on this device, how much, what that takes, and the way + * to clear it. Above that what the browser may do to it, below it the outbox + * and whatever didn't go through. Not in Lite. */ export function OfflineSettings() { const t = useTranslations('offline.settings'); - const format = useFormatter(); - const account = useAuthStore((s) => s.activeAccountId); + const tStorage = useTranslations('offlineStorage'); + const active = useAuthStore((s) => s.activeAccountId); + useAuthStore((s) => s.connectedAccountsRevision); // Re-renders when the organisation's device settings change. - const devices = useDevicePolicy(); - const enabled = useOfflineStore((s) => !!account && s.enabled.includes(account)); - const usage = useOfflineStore((s) => s.usageBytes); - const syncing = useOfflineStore((s) => !!account && s.syncing.includes(account)); - const lastSynced = useOfflineStore((s) => (account ? s.lastSyncedAt[account] : undefined)); - const unsent = useOfflineStore((s) => s.outbox.filter((row) => row.account === account).length); - const [confirmOff, setConfirmOff] = useState(false); + useDevicePolicy(); + const labels = useAccountStore((s) => s.accounts); + const enabledCount = useOfflineStore((s) => s.enabled.length); + const persist = useOfflineStore((s) => s.persist); + const [asking, setAsking] = useState(false); + + useEffect(() => { + if (IS_LITE || enabledCount === 0) return; + void readPersistence(); + void refreshUsage(); + }, [enabledCount]); if (IS_LITE) return null; - const allowed = !devices.noOffline && offlineAllowed(account); - const turnOff = () => { - if (!account) return; - void disableOffline(account); + const accounts = [...new Set([...(active ? [active] : []), ...signedInAccountIds()])]; + const several = accounts.length > 1; + const askAgain = async () => { + setAsking(true); + await requestPersistence(); + setAsking(false); }; return ( {!offlineSupported() ? (

{t('unsupported')}

- ) : !allowed ? ( -
-

{t('keep_label')}

-

{t('forbidden')}

- -
) : ( <> - - { - if (!account) return; - if (on) void enableOffline(account); - else if (unsent > 0) setConfirmOff(true); - else turnOff(); - }} - /> -
- {enabled && ( -

- {syncing - ? t('syncing') - : lastSynced - ? t('usage_updated', { size: formatFileSize(usage), time: format.relativeTime(lastSynced, Date.now()) }) - : t('usage', { size: formatFileSize(usage) })} -

+ {enabledCount > 0 && persist === 'refused' && ( +
+

{tStorage('persist_refused')}

+ +
)} + {enabledCount > 0 && safariMayDelete() && ( +

{tStorage('safari_hint')}

+ )} + {accounts.map((account, index) => ( + entry.id === account)?.email || labels.find((entry) => entry.id === account)?.label || account : null} + /> + ))} )} - setConfirmOff(false)} - onConfirm={() => { setConfirmOff(false); turnOff(); }} - title={t('off_confirm_title')} - message={t('off_confirm_message', { count: unsent })} - confirmText={t('off_confirm')} - variant="destructive" - /> ); } diff --git a/components/offline/outbox-list.tsx b/components/offline/outbox-list.tsx index 7e8c3a864..37ef47d71 100644 --- a/components/offline/outbox-list.tsx +++ b/components/offline/outbox-list.tsx @@ -5,9 +5,9 @@ import { useFormatter, useTranslations } from 'next-intl'; import { Button } from '@/components/ui/button'; import { ConfirmDialog } from '@/components/ui/confirm-dialog'; import { deleteOutboxEntry, retryOutboxEntry } from '@/lib/offline/flush'; -import { refreshQueueState, scheduleFlushAll } from '@/lib/offline/offline-mode'; +import { dismissAreaConflict, refreshQueueState, scheduleFlushAll } from '@/lib/offline/offline-mode'; import { dismissConflict, type ConflictEntry } from '@/lib/offline/queue'; -import { isOfflineNow, useOfflineStore, type OutboxRow } from '@/lib/offline/state'; +import { isOfflineNow, useOfflineStore, type AreaConflict, type OutboxRow } from '@/lib/offline/state'; import { useAccountStore } from '@/stores/account-store'; /** @@ -22,10 +22,12 @@ export function OutboxList({ heading = true }: { heading?: boolean }) { const t = useTranslations('offline.outbox'); const tErrors = useTranslations('offline.errors'); const tConflicts = useTranslations('offlineConflicts'); + const tStorage = useTranslations('offlineStorage'); const format = useFormatter(); const rows = useOfflineStore((s) => s.outbox); const changes = useOfflineStore((s) => s.pendingChanges); const conflicts = useOfflineStore((s) => s.conflicts); + const areaConflicts = useOfflineStore((s) => s.areaConflicts); const accounts = useAccountStore((s) => s.accounts); const [deleting, setDeleting] = useState(null); const several = new Set(rows.map((r) => r.account)).size > 1 || accounts.length > 1; @@ -52,6 +54,12 @@ export function OutboxList({ heading = true }: { heading?: boolean }) { return tConflicts(conflict.summary.op === 'destroy' ? 'changed_delete' : 'changed'); }; + const areaConflictText = (conflict: AreaConflict) => { + if (conflict.reason === 'refused') return tConflicts('refused', { reason: conflict.detail ?? '' }); + if (conflict.reason === 'gone') return tConflicts('gone'); + return tConflicts(conflict.destroy ? 'changed_delete' : 'changed'); + }; + const dismiss = async (conflict: ConflictEntry) => { await dismissConflict(conflict.account, conflict.id); await refreshQueueState(); @@ -92,7 +100,7 @@ export function OutboxList({ heading = true }: { heading?: boolean }) { {changes > 0 && (

{t('changes', { count: changes })}

)} - {conflicts.length > 0 && ( + {conflicts.length + areaConflicts.length > 0 && (

{tConflicts('description')}

    @@ -109,6 +117,21 @@ export function OutboxList({ heading = true }: { heading?: boolean }) {
))} + {areaConflicts.map((conflict) => ( +
  • +
    +

    + {tStorage(conflict.area === 'calendar' ? 'conflict_calendar' : 'conflict_contacts')}: {conflict.title || t('no_subject')} +

    +

    + {areaConflictText(conflict)} · {format.dateTime(conflict.createdAt, { dateStyle: 'short', timeStyle: 'short' })} +

    +
    +
    + +
    +
    • + ))} )} diff --git a/hooks/use-keep-file-offline.ts b/hooks/use-keep-file-offline.ts new file mode 100644 index 000000000..aff9cd1cb --- /dev/null +++ b/hooks/use-keep-file-offline.ts @@ -0,0 +1,39 @@ +'use client'; + +import { useCallback, useMemo } from 'react'; +import type { IJMAPClient } from '@/lib/jmap/client-interface'; +import { useAuthStore } from '@/stores/auth-store'; +import { useKeptFiles } from './use-kept-files'; + +interface FileRef { + id: string; + isDirectory?: boolean; + isSymlink?: boolean; +} + +/** + * Nodes of another account are listed as "accountId:nodeId" (stores/file-store.ts). + * The store keeps them under the account they live in. + */ +export function fileRefFor(id: string, ownAccount: string): { jmap: string; id: string } { + const at = id.indexOf(':'); + return at > 0 ? { jmap: id.slice(0, at), id: id.slice(at + 1) } : { jmap: ownAccount, id }; +} + +/** "Keep offline" in the Files app. Nothing to offer when the account doesn't keep mail here. */ +export function useKeepFileOffline(client: IJMAPClient | null | undefined) { + const account = useAuthStore((s) => s.activeAccountId); + const { active, pinned, pin, unpin } = useKeptFiles(account); + const own = client?.getAccountId() ?? ''; + + const keptOffline = useMemo(() => new Set(pinned.map((file) => (file.jmap === own ? file.id : `${file.jmap}:${file.id}`))), [pinned, own]); + + const canKeepOffline = useCallback((resource: FileRef) => active && !!own && !resource.isDirectory && !resource.isSymlink, [active, own]); + + const toggleKeptOffline = useCallback(async (resource: FileRef) => { + const ref = fileRefFor(resource.id, own); + await (keptOffline.has(resource.id) ? unpin(ref) : pin(ref)).catch(() => {}); + }, [own, keptOffline, pin, unpin]); + + return { keptOffline, canKeepOffline, toggleKeptOffline }; +} diff --git a/hooks/use-kept-files.ts b/hooks/use-kept-files.ts new file mode 100644 index 000000000..3a706968f --- /dev/null +++ b/hooks/use-kept-files.ts @@ -0,0 +1,58 @@ +'use client'; + +import { useCallback, useEffect, useMemo, useState } from 'react'; +import { getStore } from '@/lib/store/client/api'; +import { offlineActive } from '@/lib/offline/offline-mode'; +import { useOfflineStore } from '@/lib/offline/state'; + +/** A row of the Files area's `files.kept`. */ +export interface KeptFile { + jmap: string; + id: string; + name: string; + size: number | null; + pinned: boolean; + kept: boolean; + error: string | null; +} + +/** + * The files an account keeps offline, and pinning them. Nothing when the + * account doesn't keep mail here, or the build has no Files area. + */ +export function useKeptFiles(account: string | null | undefined) { + const [files, setFiles] = useState([]); + const lastSynced = useOfflineStore((s) => (account ? s.lastSyncedAt[account] : undefined)); + const active = useOfflineStore((s) => !!account && s.enabled.includes(account)) && offlineActive(account); + + const read = useCallback(async () => { + if (!account || !active) { + setFiles([]); + return; + } + try { + setFiles((await getStore().area<{ files: KeptFile[] }>(account, 'files.kept'))?.files ?? []); + } catch { + // The store is starting or being deleted, or this build has no Files area. + setFiles([]); + } + }, [account, active]); + + useEffect(() => { void read(); }, [read, lastSynced]); + + const pinned = useMemo(() => files.filter((file) => file.pinned), [files]); + + const pin = useCallback(async (ref: { jmap: string; id: string }) => { + if (!account) return; + await getStore().area(account, 'files.pin', ref); + await read(); + }, [account, read]); + + const unpin = useCallback(async (ref: { jmap: string; id: string }) => { + if (!account) return; + await getStore().area(account, 'files.unpin', ref); + await read(); + }, [account, read]); + + return { active, files, pinned, pin, unpin }; +} diff --git a/lib/__tests__/sign-out-cleanup.test.ts b/lib/__tests__/sign-out-cleanup.test.ts index 355f623e6..005865d76 100644 --- a/lib/__tests__/sign-out-cleanup.test.ts +++ b/lib/__tests__/sign-out-cleanup.test.ts @@ -26,6 +26,7 @@ describe('purgeSignedOutData', () => { for (const key of [ 'email-snapshot', 'pro-tabs', 'search-history-storage', 'calendar-storage', 'files-favorites', 'files-recent-files', 'files-path-stack', 'bulwark-delegate-names', + 'bulwark-offline-accounts', 'bulwark-offline-choices', 'bulwark-offline-health', 'settings-storage', 'theme-storage', 'locale-storage', 'template-storage', 'files-view-mode', ]) localStorage.setItem(key, 'x'); diff --git a/lib/offline/__tests__/effective-scope-wiring.test.ts b/lib/offline/__tests__/effective-scope-wiring.test.ts new file mode 100644 index 000000000..d960f0d58 --- /dev/null +++ b/lib/offline/__tests__/effective-scope-wiring.test.ts @@ -0,0 +1,216 @@ +import 'fake-indexeddb/auto'; +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; +import { DEFAULT_ORGANISATION_POLICY } from '@/lib/admin/organisation-policy'; +import { getOfflineHooks, setOfflineHooks } from '@/lib/jmap/offline-hooks'; +import { setStoreBackend } from '@/lib/store/client/api'; +import { FakeJmap } from '@/lib/store/__tests__/helpers/fake-jmap'; +import { InProcessStore } from '@/lib/store/__tests__/helpers/in-process-store'; +import { useAccountStore } from '@/stores/account-store'; +import { useAuthStore } from '@/stores/auth-store'; +import { usePolicyStore } from '@/stores/policy-store'; +import { + chooseScope, + clearAccount, + disableOffline, + enableOffline, + enforcePolicy, + registerOfflineHooks, + scopeForAccount, + setOfflineNotifier, + wipeEverything, + type OfflineNotice, +} from '../offline-mode'; +import { useOfflineStore, writeEnabled } from '../state'; + +const NOW = Date.now(); +const iso = (daysAgo: number) => new Date(NOW - daysAgo * 86_400_000).toISOString(); +const notices: OfflineNotice[] = []; +let store: InProcessStore; +let server: FakeJmap; + +function setDevices(devices: Partial): void { + usePolicyStore.setState({ + loaded: true, source: 'server', subject: null, subjectPending: false, + policy: { ...usePolicyStore.getState().policy, organisation: { ...DEFAULT_ORGANISATION_POLICY, devices: { ...DEFAULT_ORGANISATION_POLICY.devices, ...devices } } }, + } as never); +} + +const ids = (account = 'acc') => store.dbs.get(account)!.all<{ id: string }>('SELECT id FROM email ORDER BY id').map((row) => row.id); + +beforeEach(() => { + localStorage.clear(); + server = new FakeJmap(); + store = new InProcessStore(server); + setStoreBackend(store); + notices.length = 0; + setOfflineNotifier((notice) => notices.push(notice)); + useOfflineStore.setState({ enabled: [], choices: {}, health: {}, outbox: [], conflicts: [], areaConflicts: [], usage: {}, storageFull: {}, progress: {}, persist: 'unknown', browserOffline: false, downServers: [], startedOffline: false }); + useAccountStore.setState({ accounts: [{ id: 'acc', label: 'alice', serverUrl: 'https://mail.example.org', username: 'alice@example.org' } as never] }); + useAuthStore.setState({ activeAccountId: 'acc', client: null, getClientForAccount: (() => null) as never, getAllConnectedClients: (() => new Map()) as never }); + setDevices({}); +}); + +afterEach(async () => { + delete (window as { bulwarkDesktop?: unknown }).bulwarkDesktop; + setOfflineHooks(null); + setOfflineNotifier(() => {}); + await wipeEverything(); + setStoreBackend(null); +}); + +describe('a policy fetch', () => { + async function kept(): Promise { + server.addEmail({ id: 'old', receivedAt: iso(100) }); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + writeEnabled(['acc']); + useOfflineStore.setState({ choices: { acc: { on: true, days: null } } }); + await store.setScope('acc', scopeForAccount('acc').scope); + await store.sync('acc'); + expect(ids()).toEqual(['new', 'old']); + } + + it('with a lower cap prunes what is kept, without fetching what stays', async () => { + await kept(); + server.calls.length = 0; + setDevices({ offlineMaxDays: 30 }); + enforcePolicy(); + await vi.waitFor(() => expect(ids()).toEqual(['new'])); + expect(server.calls.filter(([name]) => name === 'Email/query')).toEqual([]); + }); + + it('with the cap raised again starts a backfill', async () => { + await kept(); + setDevices({ offlineMaxDays: 30 }); + enforcePolicy(); + await vi.waitFor(() => expect(ids()).toEqual(['new'])); + setDevices({}); + enforcePolicy(); + await vi.waitFor(() => expect(ids()).toEqual(['new', 'old'])); + }); + + it('with defaults only (no policy heard yet) changes nothing', async () => { + await kept(); + usePolicyStore.setState({ source: 'fallback' } as never); + const setScope = vi.spyOn(store, 'setScope'); + enforcePolicy(); + await new Promise((resolve) => setTimeout(resolve, 5)); + expect(setScope).not.toHaveBeenCalled(); + }); +}); + +describe('the user picking what to keep', () => { + it('goes to the store and prunes', async () => { + server.addEmail({ id: 'old', receivedAt: iso(100) }); + server.addEmail({ id: 'new', receivedAt: iso(5) }); + writeEnabled(['acc']); + useOfflineStore.setState({ choices: { acc: { on: true, days: null } } }); + await store.setScope('acc', scopeForAccount('acc').scope); + await store.sync('acc'); + chooseScope('acc', { days: 30 }); + await vi.waitFor(() => expect(ids()).toEqual(['new'])); + expect(JSON.parse(localStorage.getItem('bulwark-offline-choices')!).acc.days).toBe(30); + }); + + it('can\'t get past the cap', () => { + setDevices({ offlineMaxDays: 30 }); + writeEnabled(['acc']); + chooseScope('acc', { days: null }); + expect(scopeForAccount('acc').scope.days).toBe(30); + }); +}); + +describe('opened messages', () => { + it('past the organisation\'s cap aren\'t recorded; under it they are', async () => { + registerOfflineHooks(); + writeEnabled(['acc']); + setDevices({ offlineMaxDays: 30 }); + const area = vi.spyOn(store, 'area'); + const client = { getServerUrl: () => 'https://mail.example.org', getUsername: () => 'alice@example.org', getAccountId: () => 'j' } as never; + const message = (id: string, receivedAt: string) => ({ id, receivedAt, mailboxIds: { inbox: true }, bodyValues: { 1: { value: 'x', isTruncated: false } } }); + getOfflineHooks()!.record!(client, [['Email/get', { accountId: 'j' }, 'c']], { + methodResponses: [['Email/get', { accountId: 'j', list: [message('old', iso(100)), message('new', iso(5))] }, 'c']], + } as never); + await vi.waitFor(() => expect(area).toHaveBeenCalled()); + const recorded = area.mock.calls.filter(([, name]) => name === 'mail.recordOpened').flatMap(([, , params]) => (params as { emails: Array<{ id: string }> }).emails.map((email) => email.id)); + expect(recorded).toEqual(['new']); + }); +}); + +describe('clearing an account', () => { + it('removes its store and starts over, and it stays on', async () => { + server.addEmail({ id: 'new', receivedAt: iso(5) }); + writeEnabled(['acc']); + await store.sync('acc'); + expect(ids()).toEqual(['new']); + const before = store.dbs.get('acc'); + + await clearAccount('acc'); + + expect(store.removed).toContain('acc'); + expect(useOfflineStore.getState().enabled).toEqual(['acc']); + expect(store.dbs.get('acc')).not.toBe(before); + expect(useOfflineStore.getState().health.acc?.opened).toBe(false); + // It isn't read as a browser clearing the store at the next open. + expect(notices.filter((n) => n.kind === 'evicted')).toEqual([]); + }); +}); + +describe('the desktop app', () => { + const asDesktop = () => { (window as { bulwarkDesktop?: unknown }).bulwarkDesktop = { version: 1 }; }; + + it('keeps mail for an account without asking, and says so once', async () => { + asDesktop(); + enforcePolicy(); + await vi.waitFor(() => expect(useOfflineStore.getState().enabled).toEqual(['acc'])); + expect(notices.filter((n) => n.kind === 'default-on')).toHaveLength(1); + enforcePolicy(); + expect(notices.filter((n) => n.kind === 'default-on')).toHaveLength(1); + }); + + it('not when the organisation forbids it', async () => { + asDesktop(); + setDevices({ noOffline: true }); + enforcePolicy(); + await new Promise((resolve) => setTimeout(resolve, 5)); + expect(useOfflineStore.getState().enabled).toEqual([]); + expect(notices.filter((n) => n.kind === 'default-on')).toEqual([]); + }); + + it('not before the policy is known', async () => { + asDesktop(); + usePolicyStore.setState({ source: 'none' } as never); + enforcePolicy(); + await new Promise((resolve) => setTimeout(resolve, 5)); + expect(useOfflineStore.getState().enabled).toEqual([]); + }); + + it('not after the user turned it off', async () => { + asDesktop(); + enforcePolicy(); + await vi.waitFor(() => expect(useOfflineStore.getState().enabled).toEqual(['acc'])); + await disableOffline('acc'); + enforcePolicy(); + await new Promise((resolve) => setTimeout(resolve, 5)); + expect(useOfflineStore.getState().enabled).toEqual([]); + expect(useOfflineStore.getState().choices.acc?.on).toBe(false); + }); + + it('holds to a cap from the first open', async () => { + asDesktop(); + setDevices({ offlineMaxDays: 14 }); + enforcePolicy(); + await vi.waitFor(() => expect(useOfflineStore.getState().enabled).toEqual(['acc'])); + expect(scopeForAccount('acc').scope.days).toBe(14); + }); +}); + +describe('a browser', () => { + it('stays opt-in', async () => { + enforcePolicy(); + await new Promise((resolve) => setTimeout(resolve, 5)); + expect(useOfflineStore.getState().enabled).toEqual([]); + expect(notices).toEqual([]); + await enableOffline('acc'); + expect(useOfflineStore.getState().enabled).toEqual(['acc']); + }); +}); diff --git a/lib/offline/__tests__/migrate-legacy.test.ts b/lib/offline/__tests__/migrate-legacy.test.ts index 37e3fa492..532f8ba4d 100644 --- a/lib/offline/__tests__/migrate-legacy.test.ts +++ b/lib/offline/__tests__/migrate-legacy.test.ts @@ -4,7 +4,9 @@ import { setStoreBackend } from '@/lib/store/client/api'; import { InProcessStore } from '@/lib/store/__tests__/helpers/in-process-store'; import { forgetLegacyMove, LEGACY_DB_NAME, moveLegacyOutbox } from '../migrate-legacy'; import { readQueue } from '../queue'; -import { useOfflineStore } from '../state'; +import { DEFAULT_ORGANISATION_POLICY } from '@/lib/admin/organisation-policy'; +import { effectiveScope, platformDefault, userChoiceFor } from '../scope'; +import { OFFLINE_CHOICES_KEY, useOfflineStore, writeChoice } from '../state'; /** The old database, exactly as lib/offline/db.ts laid it out. */ const STORES = ['keys', 'emails', 'bodies', 'blobs', 'misc', 'ledger', 'queue', 'uploads']; @@ -72,7 +74,8 @@ beforeEach(async () => { store = new InProcessStore(); setStoreBackend(store); forgetLegacyMove(); - useOfflineStore.setState({ enabled: ['acc'] }); + localStorage.clear(); + useOfflineStore.setState({ enabled: ['acc'], choices: {} }); await new Promise((resolve) => { const request = indexedDB.deleteDatabase(LEGACY_DB_NAME); request.onsuccess = () => resolve(); @@ -156,6 +159,23 @@ describe('moving the old outbox into the store', () => { expect(await store.area('acc', 'mail.session')).toMatchObject({ apiUrl: 'https://old/jmap' }); }); + it('keeps the account on, with the 30 days it had, and writes that down as its choice', async () => { + await seedOld(); + await moveLegacyOutbox(); + const state = useOfflineStore.getState(); + expect(state.enabled).toContain('acc'); + expect(state.choices.acc).toMatchObject({ on: true, days: 30 }); + expect(JSON.parse(localStorage.getItem(OFFLINE_CHOICES_KEY)!).acc.days).toBe(30); + expect(effectiveScope('acc', userChoiceFor('acc'), DEFAULT_ORGANISATION_POLICY.devices, platformDefault()).scope.days).toBe(30); + }); + + it('never takes a window the user already picked', async () => { + await seedOld(); + writeChoice('acc', { on: true, days: 365 }); + await moveLegacyOutbox(); + expect(useOfflineStore.getState().choices.acc.days).toBe(365); + }); + it('never creates the old database when it isn\'t there', async () => { await moveLegacyOutbox(); expect(await oldExists()).toBe(false); diff --git a/lib/offline/__tests__/scope.test.ts b/lib/offline/__tests__/scope.test.ts new file mode 100644 index 000000000..2531d97d4 --- /dev/null +++ b/lib/offline/__tests__/scope.test.ts @@ -0,0 +1,122 @@ +import { afterEach, beforeEach, describe, expect, it } from 'vitest'; +import { DEFAULT_ORGANISATION_POLICY } from '@/lib/admin/organisation-policy'; +import { DEFAULT_SCOPE } from '@/lib/store/area'; +import { + attachmentCapOptions, + effectiveScope, + LEGACY_CHOICE, + offlineDefaultOn, + olderThanCap, + platformDefault, + userChoiceFor, + windowOptions, +} from '../scope'; +import { useOfflineStore } from '../state'; + +const NO_LIMITS = DEFAULT_ORGANISATION_POLICY.devices; +const MB = 1024 * 1024; +const BROWSER = { on: false, scope: DEFAULT_SCOPE }; +const DESKTOP = { on: true, scope: DEFAULT_SCOPE }; + +describe('effectiveScope', () => { + it('the default when nothing else says', () => { + expect(effectiveScope('a', null, NO_LIMITS, BROWSER)).toMatchObject({ account: 'a', enabled: false, scope: DEFAULT_SCOPE }); + expect(effectiveScope('a', null, NO_LIMITS, DESKTOP).enabled).toBe(true); + }); + + it('the user over the default', () => { + const effective = effectiveScope('a', { on: true, days: 30, attachments: false, maxAttachmentMb: 5 }, NO_LIMITS, BROWSER); + expect(effective.enabled).toBe(true); + expect(effective.scope).toEqual({ ...DEFAULT_SCOPE, days: 30, attachments: false, maxAttachmentBytes: 5 * MB }); + expect(effectiveScope('a', { on: false }, NO_LIMITS, DESKTOP).enabled).toBe(false); + expect(effectiveScope('a', { days: null }, NO_LIMITS, BROWSER).scope.days).toBeNull(); + }); + + it('the organisation over the user and over the desktop default', () => { + const policy = { ...NO_LIMITS, noOffline: true }; + expect(effectiveScope('a', { on: true }, policy, BROWSER).enabled).toBe(false); + expect(effectiveScope('a', null, policy, DESKTOP).enabled).toBe(false); + expect(effectiveScope('a', { on: true }, policy, DESKTOP).locked.offline).toBe(true); + }); + + it('a cap lowers the choice and the default, also "everything", and never raises', () => { + const policy = { ...NO_LIMITS, offlineMaxDays: 60, offlineMaxAttachmentMb: 10, offlineMaxTotalMb: 100 }; + const capped = effectiveScope('a', { days: null, maxAttachmentMb: 500 }, policy, DESKTOP); + expect(capped.scope).toEqual({ days: 60, attachments: true, maxAttachmentBytes: 10 * MB, maxTotalBytes: 100 * MB }); + expect(capped.locked).toMatchObject({ days: true, maxAttachment: true, maxTotal: true, attachments: false }); + expect(effectiveScope('a', null, { ...policy, offlineMaxDays: 30 }, DESKTOP).scope.days).toBe(30); + const under = effectiveScope('a', { days: 30, maxAttachmentMb: 5 }, policy, BROWSER); + expect(under.scope.days).toBe(30); + expect(under.scope.maxAttachmentBytes).toBe(5 * MB); + }); + + it('forbidden attachments stay off whatever the user chose', () => { + const effective = effectiveScope('a', { attachments: true }, { ...NO_LIMITS, noOfflineAttachments: true }, DESKTOP); + expect(effective.scope.attachments).toBe(false); + expect(effective.locked.attachments).toBe(true); + }); +}); + +describe('the platform default', () => { + afterEach(() => { delete (window as { bulwarkDesktop?: unknown }).bulwarkDesktop; }); + + it('is off in a browser and on with the desktop bridge', () => { + expect(offlineDefaultOn()).toBe(false); + expect(platformDefault().on).toBe(false); + (window as { bulwarkDesktop?: unknown }).bulwarkDesktop = { version: 1 }; + expect(offlineDefaultOn()).toBe(true); + expect(platformDefault().on).toBe(true); + }); +}); + +describe('what the user chose', () => { + beforeEach(() => useOfflineStore.setState({ enabled: [], choices: {} })); + + it('nothing for an account that never had it on', () => { + expect(userChoiceFor('a')).toBeNull(); + }); + + it('an account on from before the local store keeps the 30 days it had', () => { + useOfflineStore.setState({ enabled: ['a'] }); + expect(userChoiceFor('a')).toEqual(LEGACY_CHOICE); + expect(LEGACY_CHOICE.days).toBe(30); + expect(effectiveScope('a', userChoiceFor('a'), NO_LIMITS, BROWSER).scope.days).toBe(30); + }); + + it('a stored choice wins', () => { + useOfflineStore.setState({ enabled: ['a'], choices: { a: { on: true, days: 365 } } }); + expect(userChoiceFor('a')?.days).toBe(365); + }); +}); + +describe('what the page offers', () => { + it('every window without a cap', () => { + expect(windowOptions(0)).toEqual([30, 90, 365, null]); + }); + + it('what fits under a cap, and the cap itself', () => { + expect(windowOptions(90)).toEqual([30, 90]); + expect(windowOptions(60)).toEqual([30, 60]); + expect(windowOptions(7)).toEqual([7]); + expect(attachmentCapOptions(0)).toEqual([5, 25, 100, 500]); + expect(attachmentCapOptions(10)).toEqual([5, 10]); + }); +}); + +describe('Lite', () => { + it('reads the caps from the same policy.json, and has no store to apply them to', async () => { + const { applyLitePolicy } = await import('@/lib/lite-config'); + const policy = applyLitePolicy({ organisation: { devices: { offlineMaxDays: 30, noOfflineAttachments: true, offlineMaxTotalMb: 'lots' } } } as never); + expect(policy.organisation?.devices).toMatchObject({ offlineMaxDays: 30, noOfflineAttachments: true, offlineMaxTotalMb: 0 }); + }); +}); + +describe('olderThanCap', () => { + const now = Date.UTC(2026, 10, 3); + it('only with a cap, and only past it', () => { + expect(olderThanCap('2026-01-01T00:00:00Z', 0, now)).toBe(false); + expect(olderThanCap('2026-01-01T00:00:00Z', 30, now)).toBe(true); + expect(olderThanCap('2026-10-30T00:00:00Z', 30, now)).toBe(false); + expect(olderThanCap(undefined, 30, now)).toBe(false); + }); +}); diff --git a/lib/offline/__tests__/storage-health.test.ts b/lib/offline/__tests__/storage-health.test.ts new file mode 100644 index 000000000..86a85ae61 --- /dev/null +++ b/lib/offline/__tests__/storage-health.test.ts @@ -0,0 +1,326 @@ +import 'fake-indexeddb/auto'; +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; +import { DEFAULT_ORGANISATION_POLICY } from '@/lib/admin/organisation-policy'; +import { purgeSignedOutData } from '@/lib/sign-out-cleanup'; +import { configureStore, getStore, setStoreBackend } from '@/lib/store/client/api'; +import { deleteKeyDatabase, getAccountRecord, openAccountKey } from '@/lib/store/client/keys'; +import { FAKE_SESSION } from '@/lib/store/__tests__/helpers/fake-jmap'; +import { usePolicyStore } from '@/stores/policy-store'; +import { + enableOffline, + registerOfflineHooks, + setOfflineNotifier, + startOfflineMode, + wipeAccount, + wipeEverything, + type OfflineNotice, +} from '../offline-mode'; +import { readPersistence, requestPersistence, safariMayDelete, wasEvicted } from '../storage-health'; +import { OFFLINE_CHOICES_KEY, OFFLINE_HEALTH_KEY, useOfflineStore, writeChoice, writeEnabled, writeHealth } from '../state'; + +/** Everything on one page: a BroadcastChannel that also reaches other objects here, as in a browser. */ +class FakeChannel { + static open = new Set(); + onmessage: ((event: MessageEvent) => void) | null = null; + constructor(readonly name: string) { + FakeChannel.open.add(this); + } + postMessage(data: unknown): void { + for (const channel of FakeChannel.open) { + if (channel !== this && channel.name === this.name) channel.onmessage?.({ data } as MessageEvent); + } + } + close(): void { + FakeChannel.open.delete(this); + } +} + +class FakeWorker { + static all: FakeWorker[] = []; + /** What the worker found on OPFS. */ + static fileExisted = true; + onmessage: ((event: MessageEvent) => void) | null = null; + posted: Array> = []; + constructor() { + FakeWorker.all.push(this); + } + postMessage(message: Record): void { + this.posted.push(message); + if (message.kind === 'open') queueMicrotask(() => this.onmessage?.({ data: { kind: 'result', id: message.id, result: { fileExisted: FakeWorker.fileExisted } } } as MessageEvent)); + if (message.kind === 'sweep-files') queueMicrotask(() => this.onmessage?.({ data: { kind: 'result', id: message.id, result: 0 } } as MessageEvent)); + } + terminate(): void {} +} + +const rpcs: Array<{ method: string; params: { name?: string; account?: string } }> = []; + +/** The worker's side of the channel: an empty store. */ +function ownerOnChannel(): void { + const owner = new FakeChannel('bulwark-store-rpc'); + owner.onmessage = (event) => { + const message = event.data as { kind: string; id: string; from: string; method: string; params: { name?: string } }; + if (message.kind === 'who-owns') owner.postMessage({ kind: 'owner-changed', owner: 'worker' }); + if (message.kind !== 'rpc') return; + rpcs.push({ method: message.method, params: message.params }); + const name = message.params.name ?? ''; + const result = name === 'outbox.read' ? { patches: 0, entries: [], conflicts: [] } + : name.endsWith('.conflicts') ? [] + : name.endsWith('.pending') ? 0 + : name === 'store.usage' ? { bytes: 0, parts: [] } + : null; + owner.postMessage({ kind: 'reply', id: message.id, to: message.from, result }); + }; + owner.postMessage({ kind: 'owner-changed', owner: 'worker' }); +} + +const notices: OfflineNotice[] = []; + +function setStorage(storage: Record): void { + Object.defineProperty(window.navigator, 'storage', { configurable: true, value: storage }); +} + +function setUserAgent(value: string): void { + Object.defineProperty(window.navigator, 'userAgent', { configurable: true, value }); +} + +const realUserAgent = window.navigator.userAgent; + +beforeEach(() => { + localStorage.clear(); + deleteKeyDatabase(); + FakeChannel.open.clear(); + FakeWorker.all = []; + FakeWorker.fileExisted = true; + rpcs.length = 0; + notices.length = 0; + vi.stubGlobal('BroadcastChannel', FakeChannel); + vi.stubGlobal('Worker', FakeWorker); + vi.stubGlobal('FileSystemFileHandle', class {}); + setStorage({ getDirectory: async () => ({ removeEntry: async () => {} }), persist: async () => true, persisted: async () => true }); + Object.defineProperty(window.navigator, 'locks', { configurable: true, value: { request: async (_name: string, fn: () => unknown) => fn() } }); + useOfflineStore.setState({ + enabled: [], outbox: [], pendingChanges: 0, conflicts: [], areaConflicts: [], usage: {}, usageBytes: 0, choices: {}, health: {}, + storageFull: {}, progress: {}, persist: 'unknown', syncing: [], lastSyncedAt: {}, browserOffline: false, downServers: [], startedOffline: false, + }); + usePolicyStore.setState({ loaded: true, source: 'server', subject: null, subjectPending: false, policy: { ...usePolicyStore.getState().policy, organisation: DEFAULT_ORGANISATION_POLICY } } as never); + setStoreBackend(null); + setOfflineNotifier((notice) => notices.push(notice)); + registerOfflineHooks(); +}); + +afterEach(() => { + getStore().stop(); + configureStore(null); + setStoreBackend(null); + setOfflineNotifier(() => {}); + vi.unstubAllGlobals(); + delete (window.navigator as { storage?: unknown }).storage; + delete (window.navigator as { locks?: unknown }).locks; + setUserAgent(realUserAgent); +}); + +/** Opens an account in this tab, as the owner, the way the page does. */ +async function openAsOwner(account: string): Promise { + useOfflineStore.setState((s) => ({ enabled: [...s.enabled, account] })); + await getStore().ensureOpen(account, FAKE_SESSION); + const worker = FakeWorker.all.at(-1)!; + worker.onmessage?.({ data: { kind: 'owner' } } as MessageEvent); + ownerOnChannel(); + await vi.waitFor(() => expect(worker.posted.some((m) => m.kind === 'open' && (m.params as { account: string }).account === account)).toBe(true)); + return worker; +} + +describe('a store the browser cleared', () => { + it('a key with no file: warns, with how many waiting items went', async () => { + await openAccountKey('acc'); + writeHealth('acc', { opened: true, pending: 3 }); + FakeWorker.fileExisted = false; + await openAsOwner('acc'); + await vi.waitFor(() => expect(notices).toContainEqual({ kind: 'evicted', lost: 3 })); + expect(useOfflineStore.getState().health.acc.evicted?.lost).toBe(3); + expect(useOfflineStore.getState().health.acc.pending).toBe(0); + }); + + it('no key where one was made: warns too', async () => { + writeHealth('acc', { opened: true, pending: 0 }); + FakeWorker.fileExisted = false; + await openAsOwner('acc'); + await vi.waitFor(() => expect(notices).toContainEqual({ kind: 'evicted', lost: 0 })); + }); + + it('a first open is not an eviction', async () => { + FakeWorker.fileExisted = false; + await openAsOwner('acc'); + await vi.waitFor(() => expect(useOfflineStore.getState().health.acc?.opened).toBe(true)); + expect(notices.filter((n) => n.kind === 'evicted')).toEqual([]); + }); + + it('a normal start is not one either', async () => { + await openAccountKey('acc'); + writeHealth('acc', { opened: true, pending: 3 }); + await openAsOwner('acc'); + await vi.waitFor(() => expect(FakeWorker.all[0].posted.some((m) => m.kind === 'open')).toBe(true)); + await new Promise((resolve) => setTimeout(resolve, 5)); + expect(notices).toEqual([]); + }); + + it('files with no key are swept once this tab owns the store', async () => { + const { record } = await openAccountKey('acc'); + const worker = await openAsOwner('acc'); + await vi.waitFor(() => expect(worker.posted.some((m) => m.kind === 'sweep-files')).toBe(true)); + expect((worker.posted.find((m) => m.kind === 'sweep-files') as { known: string[] }).known).toEqual([record.file]); + }); + + it('wasEvicted', () => { + expect(wasEvicted({ opened: true, hadKey: true, fileExisted: false })).toBe(true); + expect(wasEvicted({ opened: false, hadKey: true, fileExisted: false })).toBe(true); + expect(wasEvicted({ opened: true, hadKey: false, fileExisted: false })).toBe(true); + expect(wasEvicted({ opened: false, hadKey: false, fileExisted: false })).toBe(false); + expect(wasEvicted({ opened: true, hadKey: true, fileExisted: true })).toBe(false); + }); + + it('keeps only numbers about it outside the store', () => { + writeHealth('acc', { opened: true, pending: 2, evicted: { at: 5, lost: 2 }, lastSync: 9 }); + expect(JSON.parse(localStorage.getItem(OFFLINE_HEALTH_KEY)!)).toEqual({ acc: { opened: true, pending: 2, evicted: { at: 5, lost: 2 }, lastSync: 9 } }); + }); +}); + +describe('a failed write', () => { + it('says the device is full, at most once in a while, until a sync goes through', async () => { + const worker = await openAsOwner('acc'); + const event = (e: unknown) => worker.onmessage?.({ data: { kind: 'event', event: e } } as MessageEvent); + event({ type: 'error', account: 'acc', area: 'storage', message: 'SQLITE_FULL' }); + event({ type: 'error', account: 'acc', area: 'storage', message: 'SQLITE_FULL' }); + expect(notices.filter((n) => n.kind === 'storage-failed').length).toBeLessThanOrEqual(1); + expect(useOfflineStore.getState().storageFull.acc).toBeGreaterThan(0); + event({ type: 'synced', account: 'acc', at: 123 }); + expect(useOfflineStore.getState().storageFull.acc).toBeUndefined(); + expect(useOfflineStore.getState().health.acc?.lastSync).toBe(123); + }); +}); + +describe('asking the browser to keep it', () => { + it('asks when offline is turned on, and remembers a refusal', async () => { + const persist = vi.fn(async () => false); + setStorage({ persist, persisted: async () => false, getDirectory: async () => ({}) }); + await enableOffline('acc').catch(() => {}); + await vi.waitFor(() => expect(useOfflineStore.getState().persist).toBe('refused')); + expect(persist).toHaveBeenCalledTimes(1); + }); + + it('asks again after an install', async () => { + const persist = vi.fn(async () => true); + setStorage({ persist, persisted: async () => false, getDirectory: async () => ({}) }); + writeEnabled(['acc']); + const stop = startOfflineMode(); + window.dispatchEvent(new Event('appinstalled')); + await vi.waitFor(() => expect(persist).toHaveBeenCalled()); + await vi.waitFor(() => expect(useOfflineStore.getState().persist).toBe('granted')); + stop(); + registerOfflineHooks(); + }); + + it('tells a browser without the API from a refusal', async () => { + setStorage({}); + expect(await requestPersistence()).toBe('unsupported'); + expect(await readPersistence()).toBe('unsupported'); + }); +}); + +describe('the Safari hint', () => { + const IPHONE = 'Mozilla/5.0 (iPhone; CPU iPhone OS 17_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.5 Mobile/15E148 Safari/604.1'; + const IPAD_CHROME = 'Mozilla/5.0 (iPad; CPU OS 17_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/126.0 Mobile/15E148 Safari/604.1'; + const MAC_SAFARI = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14_5) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.5 Safari/605.1.15'; + const MAC_CHROME = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0 Safari/537.36'; + const WIN_EDGE = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0 Safari/537.36 Edg/126.0'; + const ANDROID_WEBVIEW = 'Mozilla/5.0 (Linux; Android 14) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/126.0 Mobile Safari/537.36'; + const FIREFOX = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14.5; rv:128.0) Gecko/20100101 Firefox/128.0'; + const ELECTRON = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14_5) AppleWebKit/537.36 (KHTML, like Gecko) Bulwark/1.0 Chrome/126.0 Electron/31.0 Safari/537.36'; + + it('shows in Safari and on iOS browsers that are not installed', () => { + for (const ua of [IPHONE, IPAD_CHROME, MAC_SAFARI]) expect(safariMayDelete(ua, false)).toBe(true); + }); + + it('not once installed', () => { + for (const ua of [IPHONE, MAC_SAFARI]) expect(safariMayDelete(ua, true)).toBe(false); + }); + + it('nowhere else', () => { + for (const ua of [MAC_CHROME, WIN_EDGE, ANDROID_WEBVIEW, FIREFOX, ELECTRON]) expect(safariMayDelete(ua, false)).toBe(false); + }); + + it('reads the real browser by default', () => { + setUserAgent(MAC_SAFARI); + expect(safariMayDelete()).toBe(true); + setUserAgent(MAC_CHROME); + expect(safariMayDelete()).toBe(false); + }); +}); + +describe('removing an account', () => { + it('takes its data, key, choice and counts, and leaves the other account alone', async () => { + const { record } = await openAccountKey('gone'); + await openAccountKey('stays'); + writeEnabled(['gone', 'stays']); + writeChoice('gone', { days: 30 }); + writeChoice('stays', { days: 90 }); + writeHealth('gone', { opened: true, pending: 1 }); + await openAsOwner('stays'); + + await wipeAccount('gone'); + + expect(await getAccountRecord('gone')).toBeNull(); + expect(await getAccountRecord('stays')).not.toBeNull(); + expect(rpcs).toContainEqual({ method: 'removeAccount', params: { account: 'gone', file: record.file } }); + expect(useOfflineStore.getState().choices).toEqual({ stays: { days: 90 } }); + expect(useOfflineStore.getState().health.gone).toBeUndefined(); + expect(JSON.parse(localStorage.getItem(OFFLINE_CHOICES_KEY)!)).toEqual({ stays: { days: 90 } }); + }); + + it('with the last account, deletes the pool and every key', async () => { + const removeEntry = vi.fn(async () => {}); + setStorage({ getDirectory: async () => ({ removeEntry }), persist: async () => true }); + await openAccountKey('acc'); + writeEnabled(['acc']); + writeChoice('acc', { days: 30 }); + + await wipeAccount('acc'); + + expect(removeEntry).toHaveBeenCalledWith('.bulwark-store', { recursive: true }); + await vi.waitFor(async () => expect(await getAccountRecord('acc')).toBeNull()); + expect(localStorage.getItem(OFFLINE_CHOICES_KEY)).toBeNull(); + expect(localStorage.getItem(OFFLINE_HEALTH_KEY)).toBeNull(); + }); + + it('wipeEverything leaves nothing either', async () => { + const removeEntry = vi.fn(async () => {}); + setStorage({ getDirectory: async () => ({ removeEntry }) }); + await openAccountKey('a'); + await openAccountKey('b'); + writeEnabled(['a', 'b']); + await wipeEverything(); + expect(removeEntry).toHaveBeenCalled(); + await vi.waitFor(async () => expect(await getAccountRecord('a')).toBeNull()); + expect(await getAccountRecord('b')).toBeNull(); + expect(useOfflineStore.getState().enabled).toEqual([]); + }); +}); + +describe('a full sign-out', () => { + it('deletes the files, every key and what was stored about them', async () => { + const removeEntry = vi.fn(async () => {}); + setStorage({ getDirectory: async () => ({ removeEntry }) }); + await openAccountKey('acc'); + writeEnabled(['acc']); + writeChoice('acc', { days: 30 }); + writeHealth('acc', { opened: true, pending: 2 }); + + purgeSignedOutData(); + + await vi.waitFor(() => expect(removeEntry).toHaveBeenCalledWith('.bulwark-store', { recursive: true })); + await vi.waitFor(async () => expect(await getAccountRecord('acc')).toBeNull()); + for (const key of ['bulwark-offline-accounts', OFFLINE_CHOICES_KEY, OFFLINE_HEALTH_KEY]) expect(localStorage.getItem(key)).toBeNull(); + expect(useOfflineStore.getState().choices).toEqual({}); + expect(useOfflineStore.getState().health).toEqual({}); + }); +}); diff --git a/lib/offline/__tests__/sync-progress.test.ts b/lib/offline/__tests__/sync-progress.test.ts new file mode 100644 index 000000000..6bba589c9 --- /dev/null +++ b/lib/offline/__tests__/sync-progress.test.ts @@ -0,0 +1,50 @@ +import { describe, expect, it } from 'vitest'; +import { minutesLeft, nextProgress, progressWorthShowing } from '../sync-progress'; + +const event = (phase: string, done: number, total: number | null) => ({ area: 'mail', phase, done, total }); + +describe('the time left', () => { + it('says nothing until it has seen enough', () => { + const start = nextProgress(undefined, event('bodies', 0, 1000), 0); + expect(minutesLeft(start)).toBeNull(); + expect(minutesLeft(nextProgress(start, event('bodies', 100, 1000), 1_000))).toBeNull(); + }); + + it('works from the rate of this phase', () => { + const start = nextProgress(undefined, event('bodies', 0, 6000), 0); + // 100 a second: 59 s left rounds up. + expect(minutesLeft(nextProgress(start, event('bodies', 100, 6000), 1_000))).toBeNull(); + expect(minutesLeft(nextProgress(start, event('bodies', 600, 6000), 6_000))).toBe(1); + }); + + it('while listing, counts the bodies that come after', () => { + const start = nextProgress(undefined, event('list', 0, 50_000), 0); + const left = minutesLeft(nextProgress(start, event('list', 7_000, 50_000), 5_000)); + // Bench rig: 35 s to list, about 7 minutes in all. + expect(left).toBeGreaterThanOrEqual(5); + expect(left).toBeLessThanOrEqual(10); + }); + + it('starts over with each phase', () => { + const list = nextProgress(undefined, event('list', 1000, 1000), 0); + const bodies = nextProgress(list, event('bodies', 10, 1000), 60_000); + expect(bodies.startedAt).toBe(60_000); + expect(bodies.startedDone).toBe(10); + }); + + it('has no time without a total, or when done', () => { + const open = nextProgress(undefined, event('list', 0, null), 0); + expect(minutesLeft(nextProgress(open, event('list', 500, null), 10_000))).toBeNull(); + const done = nextProgress(undefined, event('bodies', 0, 100), 0); + expect(minutesLeft(nextProgress(done, event('bodies', 100, 100), 10_000))).toBeNull(); + }); +}); + +describe('what is worth a line', () => { + it('a big job or an unknown one, not a few new messages', () => { + expect(progressWorthShowing(undefined)).toBe(false); + expect(progressWorthShowing(nextProgress(undefined, event('bodies', 1, 3), 0))).toBe(false); + expect(progressWorthShowing(nextProgress(undefined, event('bodies', 1, 500), 0))).toBe(true); + expect(progressWorthShowing(nextProgress(undefined, event('list', 500, null), 0))).toBe(true); + }); +}); diff --git a/lib/offline/migrate-legacy.ts b/lib/offline/migrate-legacy.ts index d9a6c0253..9be4c2d8f 100644 --- a/lib/offline/migrate-legacy.ts +++ b/lib/offline/migrate-legacy.ts @@ -14,7 +14,8 @@ import { getStore } from '@/lib/store/client/api'; import type { StoreSession } from '@/lib/store/engine/transport'; import type { LegacyImport } from '@/lib/store/outbox/calls'; import type { OutboxError, OutboxStatus, OutboxSummary, PolicyFingerprint, SendItem } from '@/lib/store/outbox/items'; -import { useOfflineStore } from './state'; +import { LEGACY_CHOICE } from './scope'; +import { useOfflineStore, writeChoice } from './state'; export const LEGACY_DB_NAME = 'bulwark-offline'; @@ -172,6 +173,8 @@ async function moveNow(): Promise { const keyRecord = await result(db.transaction('keys', 'readonly').objectStore('keys').get('aes')) as { key: CryptoKey } | undefined; const key = keyRecord?.key ?? null; for (const account of useOfflineStore.getState().enabled) { + // Keeps the window it had: a choice now, so a later default can't change it. + if (!useOfflineStore.getState().choices[account]) writeChoice(account, LEGACY_CHOICE); const part = await readAccount(db, key, account); const { session, ...content } = part; if (session) await getStore().ensureOpen(account, session); diff --git a/lib/offline/offline-mode.ts b/lib/offline/offline-mode.ts index 1993f154d..9ccda7694 100644 --- a/lib/offline/offline-mode.ts +++ b/lib/offline/offline-mode.ts @@ -21,13 +21,13 @@ */ import { IS_LITE } from '@/lib/lite'; -import { devicesForAccount } from '@/lib/device-policy'; +import { devicesForAccount, signedInAccountIds } from '@/lib/device-policy'; import { accountSubjectPending, useAccountSubjects } from '@/lib/org/account-subjects'; import { labelsPolicyFor } from '@/lib/outgoing/classification'; import { getSendGuardSource, guardState, guardsSending } from '@/lib/plugin-send-guards'; import { emitPushStateChange } from '@/lib/push-events'; import { requestOutboxSync } from '@/lib/pwa-notify/outbox-sync'; -import { STORAGE_ERROR_AREA } from '@/lib/store/area'; +import { STORAGE_ERROR_AREA, type StoreScope, type StoreUsage } from '@/lib/store/area'; import { configureStore, getStore, type StorePageHooks } from '@/lib/store/client/api'; import { purgeStoreFiles } from '@/lib/store/client/purge'; import type { StoreSession } from '@/lib/store/engine/transport'; @@ -52,7 +52,30 @@ import { type PolicyFingerprint, } from './queue'; import { clearHandoffs } from '@/lib/launch-handoff'; -import { isOfflineNow, OFFLINE_ACCOUNTS_KEY, readEnabledFrom, serverKey, setServerDown, useOfflineStore, writeEnabled, type OutboxRow } from './state'; +import { + forgetAccountState, + forgetAllAccountState, + isOfflineNow, + OFFLINE_ACCOUNTS_KEY, + OFFLINE_CHOICES_KEY, + OFFLINE_HEALTH_KEY, + readEnabledFrom, + readStoredChoices, + readStoredHealth, + serverKey, + setServerDown, + useOfflineStore, + writeChoice, + writeEnabled, + writeHealth, + type AreaConflict, + type OutboxRow, + type UserChoice, +} from './state'; +import { effectiveScope, offlineDefaultOn, olderThanCap, platformDefault, userChoiceFor, type EffectiveScope } from './scope'; +import { isStandaloneDisplayMode } from '@/lib/standalone-display'; +import { readPersistence, requestPersistence, safariMayDelete, wasEvicted } from './storage-health'; +import { nextProgress } from './sync-progress'; import { flushQueue, settleStaleSends } from './flush'; import { LEGACY_DB_NAME, moveLegacyOutbox } from './migrate-legacy'; import { deleteShellCaches, tellServiceWorker } from './shell'; @@ -66,6 +89,8 @@ export type OfflineNotice = | { kind: 'lost'; subjects: string[] } | { kind: 'conflict'; count: number } | { kind: 'storage-failed' } + | { kind: 'evicted'; lost: number } + | { kind: 'default-on' } | { kind: 'refused-delete' } | { kind: 'refused-other' } | { kind: 'forbidden' } @@ -107,6 +132,11 @@ export function offlineAllowed(account: string | null | undefined): boolean { return offlineSupported() && !devicesForAccount(account ?? null).noOffline; } +/** What this account keeps here: the organisation's policy over the user's choice over the platform's default. */ +export function scopeForAccount(account: string): EffectiveScope { + return effectiveScope(account, userChoiceFor(account), devicesForAccount(account), platformDefault()); +} + /** "Keep mail on this device" is on for this account here, and allowed. */ export function offlineActive(account: string | null | undefined): boolean { return !!account && useOfflineStore.getState().enabled.includes(account) && offlineAllowed(account); @@ -145,6 +175,9 @@ const storeHooks: StorePageHooks = { return { session: (client?.getSessionSnapshot() as StoreSession | undefined) ?? null, auth: client?.getAuthHeader() ?? null, + // Until the policy is known the store keeps its last scope, so a slow + // start doesn't read as a wider window that has to be fetched. + scope: scopeDecided(account) ? scopeForAccount(account).scope : undefined, invertedKeywordSort: client?.keywordSortInverted() ?? null, }; }, @@ -155,12 +188,34 @@ const storeHooks: StorePageHooks = { await client.requestNetworkOnly([['Core/echo', {}, '0']]); return client.getAuthHeader(); }, + onOpened(account, found) { + const health = useOfflineStore.getState().health[account]; + if (wasEvicted({ opened: !!health?.opened, ...found })) { + const lost = health?.pending ?? 0; + writeHealth(account, { opened: true, pending: 0, evicted: { at: Date.now(), lost } }); + notify({ kind: 'evicted', lost }); + void refreshQueueState(); + return; + } + writeHealth(account, { opened: true }); + }, onEvent(event) { if (event.type === 'synced') { - useOfflineStore.setState((s) => ({ lastSyncedAt: { ...s.lastSyncedAt, [event.account]: event.at } })); + useOfflineStore.setState((s) => { + const { [event.account]: _full, ...storageFull } = s.storageFull; + const { [event.account]: _progress, ...progress } = s.progress; + return { lastSyncedAt: { ...s.lastSyncedAt, [event.account]: event.at }, storageFull, progress }; + }); + writeHealth(event.account, { lastSync: event.at }); void refreshUsage(); + // A pass also sends what the calendar and contacts have waiting. + void refreshQueueState(); + } + if (event.type === 'progress') { + useOfflineStore.setState((s) => ({ progress: { ...s.progress, [event.account]: nextProgress(s.progress[event.account], event, Date.now()) } })); } if (event.type === 'error' && event.area === STORAGE_ERROR_AREA) { + useOfflineStore.setState((s) => ({ storageFull: { ...s.storageFull, [event.account]: s.storageFull[event.account] ?? Date.now() } })); const now = Date.now(); if (now - lastStorageNotice < STORAGE_NOTICE_MS) return; lastStorageNotice = now; @@ -194,6 +249,9 @@ function noticeRefused(answered: OfflineResponse | null, methodCalls: OfflineMet notify({ kind: emptied ? 'refused-delete' : 'refused-other' }); } +/** What the store may keep for later when it answers for the server. */ +const QUEUEING_METHOD = /^(Email|CalendarEvent|Calendar|ContactCard|AddressBook)\/set$/; + const probes = new Map>(); /** A black-holed connection never answers the probe either. */ const PROBE_TIMEOUT_MS = 5_000; @@ -238,7 +296,7 @@ const hooks: OfflineHooks = { // The store couldn't start or lost its owner: as if nothing were kept. } noticeRefused(answered, methodCalls); - if (methodCalls.some(([name]) => name === 'Email/set') && answered) { + if (answered && methodCalls.some(([name]) => QUEUEING_METHOD.test(name))) { requestOutboxSync(); void refreshQueueState(); } @@ -270,7 +328,11 @@ const hooks: OfflineHooks = { if (!offlineActive(account) || !account) return; for (const [name, result, callId] of response.methodResponses) { if (name !== 'Email/get' || !Array.isArray(result?.list)) continue; - const opened = (result.list as Array<{ bodyValues?: Record }>).filter(hasWholeText); + // Past the organisation's cap a message isn't kept, however it got opened. + const cap = devicesForAccount(account).offlineMaxDays; + const now = Date.now(); + const opened = (result.list as Array<{ bodyValues?: Record; receivedAt?: unknown }>) + .filter((email) => hasWholeText(email) && !olderThanCap(email.receivedAt, cap, now)); if (opened.length === 0) continue; const args = methodCalls.find(([n, , id]) => id === callId && n === name)?.[1]; const jmap = (result.accountId as string) || (args?.accountId as string) || client.getAccountId(); @@ -471,13 +533,13 @@ export async function refreshQueueState(): Promise { // Nothing is kept for an account that hasn't it on; and opening the // store would create it (on the sign-in page, after a sign-out). if (useOfflineStore.getState().enabled.length === 0) { - useOfflineStore.setState({ outbox: [], pendingChanges: 0, conflicts: [] }); + useOfflineStore.setState({ outbox: [], pendingChanges: 0, conflicts: [], areaConflicts: [] }); return; } try { // Sends of a tab closed on the way: uncertain, so they can be looked up. await settleStaleSends(); - const { patches, outbox: entries, conflicts } = await readQueue(); + const { patches, patchesBy, outbox: entries, conflicts } = await readQueue(); const rows: OutboxRow[] = entries.map((entry) => ({ id: entry.id, account: entry.account, @@ -487,17 +549,72 @@ export async function refreshQueueState(): Promise { status: entry.status, error: entry.error, })); - useOfflineStore.setState({ outbox: rows, pendingChanges: patches, conflicts }); + const { enabled } = useOfflineStore.getState(); + const areas = await Promise.all(enabled.map(readAreaState)); + useOfflineStore.setState({ outbox: rows, pendingChanges: patches, conflicts, areaConflicts: areas.flatMap((area) => area.conflicts) }); + // What a browser clearing the store would lose. Counted here, and the + // count is all that's kept outside the store. + enabled.forEach((account, index) => { + const sends = rows.filter((row) => row.account === account).length; + writeHealth(account, { pending: sends + (patchesBy[account] ?? 0) + areas[index].pending }); + }); } catch { // The store is being deleted, or can't start. } } +interface StoredCalendarConflict { id: number; createdAt: number; title: string | null; reason: 'refused' | 'changedOnServer' | 'destroyedOnServer'; kind: string; description: string | null; errorType: string | null } +interface StoredContactConflict { id: number; createdAt: number; summary: string; kind: 'refused' | 'changed' | 'gone'; local: { op?: string }; error: string | null } + +/** What the calendar and contacts have waiting or couldn't send. An area this build doesn't have counts as empty. */ +async function readAreaState(account: string): Promise<{ conflicts: AreaConflict[]; pending: number }> { + const read = (name: string, none: T) => getStore().area(account, name).then((value) => value ?? none, () => none); + const [calendar, contacts, calendarPending, contactsPending] = await Promise.all([ + read('calendar.conflicts', []), + read('contacts.conflicts', []), + read('calendar.pending', 0), + read('contacts.pending', 0), + ]); + const conflicts: AreaConflict[] = [ + ...calendar.map((row): AreaConflict => ({ + area: 'calendar', + account, + id: row.id, + createdAt: row.createdAt, + title: row.title ?? '', + reason: row.reason === 'refused' ? 'refused' : row.reason === 'destroyedOnServer' ? 'gone' : 'changed', + destroy: row.kind === 'destroy', + detail: row.description ?? row.errorType, + })), + ...contacts.map((row): AreaConflict => ({ + area: 'contacts', + account, + id: row.id, + createdAt: row.createdAt, + title: row.summary, + reason: row.kind, + destroy: row.local?.op === 'destroy', + detail: row.error, + })), + ]; + return { conflicts, pending: calendarPending + contactsPending }; +} + +/** The user has seen it: the calendar's or the contacts' copy stays as the server has it. */ +export async function dismissAreaConflict(conflict: AreaConflict): Promise { + await getStore().area(conflict.account, `${conflict.area}.dismissConflict`, { id: conflict.id }); + await refreshQueueState(); +} + export async function refreshUsage(): Promise { - if (!offlineSupported() || useOfflineStore.getState().enabled.length === 0) return; + const { enabled } = useOfflineStore.getState(); + if (!offlineSupported() || enabled.length === 0) return; try { - const usage = await Promise.all(useOfflineStore.getState().enabled.map((account) => getStore().area<{ bytes: number }>(account, 'mail.usage'))); - useOfflineStore.setState({ usageBytes: usage.reduce((sum, { bytes }) => sum + bytes, 0) }); + const usage = await Promise.all(enabled.map((account) => getStore().area(account, 'store.usage'))); + useOfflineStore.setState({ + usageBytes: usage.reduce((sum, { bytes }) => sum + bytes, 0), + usage: Object.fromEntries(enabled.map((account, index) => [account, usage[index]])), + }); } catch { /* deleted meanwhile */ } @@ -586,6 +703,7 @@ async function flushAreas(account: string, client: NonNullable(account, call).catch(() => null); if (!tally) continue; const conflicts = Array.isArray(tally.conflicts) ? tally.conflicts.length : tally.conflicts ?? 0; + if (conflicts > 0) notify({ kind: 'conflict', count: conflicts }); if (!tally.sent && !conflicts) continue; const role = (useAuthStore.getState().client as unknown) === client ? 'active' : 'background'; const changed = { [client.getAccountId()]: Object.fromEntries(types.map((type) => [type, 'flushed'])) }; @@ -632,13 +750,12 @@ export async function flushAll(): Promise { export async function enableOffline(account: string): Promise { if (!offlineAllowed(account)) return; const enabled = useOfflineStore.getState().enabled; + // Before the list: an account on the list without a choice is one from before the local store. + writeChoice(account, { on: true }); if (!enabled.includes(account)) writeEnabled([...enabled, account]); - // Ask the browser not to clear it when space runs low (it may say no). - try { - void navigator.storage?.persist?.().catch(() => false); - } catch { - /* no Storage API */ - } + // Ask the browser not to clear it when space runs low. It may say no, which + // the settings page shows, with a way to ask again. + void requestPersistence(); await getStore().ensureOpen(account).catch(() => {}); await tellServiceWorker(true); scheduleSync(account, 0); @@ -648,10 +765,94 @@ export async function enableOffline(account: string): Promise { export async function disableOffline(account: string): Promise { confirmLoss(account); clearHandoffs(); - writeEnabled(useOfflineStore.getState().enabled.filter((id) => id !== account)); - await wipeAccount(account); + disabling.add(account); + try { + writeEnabled(useOfflineStore.getState().enabled.filter((id) => id !== account)); + await wipeAccount(account); + // Remembered where the app would turn it on by itself. + if (offlineDefaultOn()) writeChoice(account, { on: false }); + } finally { + disabling.delete(account); + } } +/** On their way off: the desktop default doesn't turn them back on meanwhile. */ +const disabling = new Set(); + +/** + * Removes everything kept for an account, unsent messages included (the user + * confirmed), and its key, and starts again from the server if it stays on. + */ +export async function clearAccount(account: string): Promise { + confirmLoss(account); + const timer = syncTimers.get(account); + if (timer) clearTimeout(timer); + syncTimers.delete(account); + await nameLost(account, false); + named.delete(account); + try { + await getStore().remove(account); + } catch { + // No store: nothing to remove. The key is gone in any case. + } + writeHealth(account, { opened: false, pending: 0, evicted: undefined, lastSync: undefined }); + useOfflineStore.setState((s) => { + const { [account]: _usage, ...usage } = s.usage; + const { [account]: _full, ...storageFull } = s.storageFull; + const { [account]: _progress, ...progress } = s.progress; + const { [account]: _synced, ...lastSyncedAt } = s.lastSyncedAt; + return { usage, storageFull, progress, lastSyncedAt }; + }); + await refreshQueueState(); + if (useOfflineStore.getState().enabled.includes(account)) { + await getStore().ensureOpen(account).catch(() => {}); + scheduleSync(account, 0); + } +} + +/** The user changed what an account keeps. Written first, so a reload holds to it. */ +export function chooseScope(account: string, patch: UserChoice): void { + writeChoice(account, patch); + pushScope(account); +} + +/** The store's scope follows the page's answer. Nothing happens in the store if it's the same as before. */ +function pushScope(account: string): void { + if (!useOfflineStore.getState().enabled.includes(account) || !scopeDecided(account) || !offlineActive(account)) return; + const scope: StoreScope = scopeForAccount(account).scope; + void getStore().setScope(account, scope).then(() => refreshUsage()).catch(() => {}); +} + +/** The notice about the desktop default was shown on this device. Not account data, so it outlives a sign-out. */ +const DEFAULT_ON_NOTICE_KEY = 'bulwark-offline-default-notice'; + +/** + * The desktop app keeps mail for every account without asking, unless the + * organisation forbids it or the user turned it off. Says so once. + */ +function applyDefaultOn(): void { + if (!offlineDefaultOn() || !offlineSupported()) return; + for (const account of signedInAccountIds()) { + if (useOfflineStore.getState().enabled.includes(account) || disabling.has(account) || !scopeDecided(account)) continue; + if (!scopeForAccount(account).enabled) continue; + void enableOffline(account); + try { + if (localStorage.getItem(DEFAULT_ON_NOTICE_KEY)) continue; + localStorage.setItem(DEFAULT_ON_NOTICE_KEY, '1'); + } catch { + continue; + } + notify({ kind: 'default-on' }); + } +} + +/** The evicted warning was read. */ +export function dismissEvicted(account: string): void { + writeHealth(account, { evicted: undefined }); +} + +export { readPersistence, requestPersistence, safariMayDelete }; + // ---- Unsent mail a wipe deletes ---- // The user agreed to lose unsent mail (the sign-out question, switching @@ -706,6 +907,7 @@ export async function wipeAccount(account: string): Promise { if (useOfflineStore.getState().enabled.includes(account)) { writeEnabled(useOfflineStore.getState().enabled.filter((id) => id !== account)); } + forgetAccountState(account); // Nobody keeps mail here any more: everything goes (and isn't opened // again, which would create it anew). if (useOfflineStore.getState().enabled.length === 0) { @@ -726,6 +928,7 @@ export async function wipeEverything(): Promise { for (const timer of syncTimers.values()) clearTimeout(timer); syncTimers.clear(); writeEnabled([]); + forgetAllAccountState(); getStore().stop(); await purgeStoreFiles(); try { @@ -738,7 +941,13 @@ export async function wipeEverything(): Promise { clearHandoffs(); confirmed.clear(); named.clear(); - useOfflineStore.setState({ outbox: [], pendingChanges: 0, conflicts: [], usageBytes: 0, syncing: [], lastSyncedAt: {} }); + useOfflineStore.setState({ outbox: [], pendingChanges: 0, conflicts: [], areaConflicts: [], usageBytes: 0, syncing: [], lastSyncedAt: {} }); +} + +/** The organisation's word on this account, from the server or the last fetch. Defaults aren't its word. */ +function scopeDecided(account: string): boolean { + const { loaded, source } = usePolicyStore.getState(); + return loaded && (source === 'server' || source === 'cache') && policyDecided(account); } /** Whether the policy of an account is known well enough to decide on it. */ @@ -761,8 +970,12 @@ export function enforcePolicy(): void { clearHandoffs(); void wipeAccount(account); notify({ kind: 'forbidden' }); + continue; } + // A lowered cap prunes what's kept, and a raised one starts fetching. + pushScope(account); } + applyDefaultOn(); } // ---- Started without the server ---- @@ -852,6 +1065,8 @@ export function startOfflineMode(): () => void { // there): stop here too, and don't write anything for that account. One // switched on there has to be opened here if this tab owns the store. const onStorage = (event: StorageEvent) => { + if (event.key === OFFLINE_CHOICES_KEY || event.key === null) useOfflineStore.setState({ choices: readStoredChoices() }); + if (event.key === OFFLINE_HEALTH_KEY || event.key === null) useOfflineStore.setState({ health: readStoredHealth() }); if (event.key !== OFFLINE_ACCOUNTS_KEY && event.key !== null) return; const next = readEnabledFrom(event.key === null ? null : event.newValue); const before = useOfflineStore.getState().enabled; @@ -885,6 +1100,7 @@ export function startOfflineMode(): () => void { // Session, then a sync, for every account signed in with offline mode on. const syncSignedIn = () => { + applyDefaultOn(); for (const account of useOfflineStore.getState().enabled) { const client = onlineClientFor(account); if (!client || !offlineActive(account)) continue; @@ -906,7 +1122,16 @@ export function startOfflineMode(): () => void { clearInterval(reconnect); }); - if (useOfflineStore.getState().enabled.length > 0) void tellServiceWorker(true); + if (useOfflineStore.getState().enabled.length > 0) { + void tellServiceWorker(true); + void readPersistence().then((state) => { + if (state === 'refused' && isStandaloneDisplayMode()) void requestPersistence(); + }); + } + // An installed app is usually told yes where the tab was told no. + const onInstalled = () => { if (useOfflineStore.getState().enabled.length > 0) void requestPersistence(); }; + window.addEventListener('appinstalled', onInstalled); + cleanups.push(() => window.removeEventListener('appinstalled', onInstalled)); void (async () => { await moveLegacyOutbox(); await refreshQueueState(); @@ -934,7 +1159,10 @@ onFullSignOut(() => { getStore().stop(); confirmed.clear(); named.clear(); - useOfflineStore.setState({ enabled: [], outbox: [], pendingChanges: 0, conflicts: [], usageBytes: 0, syncing: [], lastSyncedAt: {}, startedOffline: false }); + useOfflineStore.setState({ + enabled: [], outbox: [], pendingChanges: 0, conflicts: [], areaConflicts: [], usageBytes: 0, usage: {}, choices: {}, health: {}, + storageFull: {}, progress: {}, syncing: [], lastSyncedAt: {}, startedOffline: false, + }); }); // Every sign-out the user didn't agree to lose mail at (the session limits, diff --git a/lib/offline/queue.ts b/lib/offline/queue.ts index 5686f1fc5..f709431eb 100644 --- a/lib/offline/queue.ts +++ b/lib/offline/queue.ts @@ -39,11 +39,12 @@ interface StoredQueue { } /** Everything waiting for one account (or every account with it on), oldest first. */ -export async function readQueue(account?: string): Promise<{ patches: number; outbox: OutboxEntry[]; conflicts: ConflictEntry[] }> { +export async function readQueue(account?: string): Promise<{ patches: number; patchesBy: Record; outbox: OutboxEntry[]; conflicts: ConflictEntry[] }> { const accounts = account ? [account] : useOfflineStore.getState().enabled; const read = await Promise.all(accounts.map(async (id) => ({ id, queue: await getStore().area(id, 'outbox.read') }))); return { patches: read.reduce((sum, { queue }) => sum + queue.patches, 0), + patchesBy: Object.fromEntries(read.map(({ id, queue }) => [id, queue.patches])), outbox: read.flatMap(({ id, queue }) => queue.entries.map((entry) => ({ ...entry, account: id }))), conflicts: read.flatMap(({ id, queue }) => queue.conflicts.map((conflict) => ({ id: conflict.id, diff --git a/lib/offline/scope.ts b/lib/offline/scope.ts new file mode 100644 index 000000000..5398a0161 --- /dev/null +++ b/lib/offline/scope.ts @@ -0,0 +1,125 @@ +/** + * What an account keeps on this device. Three sources, in this order: the + * organisation's policy, the user's choice, the platform's default. The policy + * only ever lowers: nothing below it can raise a cap or turn back on what it + * forbids, and that includes the desktop app's default of keeping mail. + */ + +import { DEFAULT_SCOPE, type StoreScope } from '@/lib/store/area'; +import type { DevicePolicy } from '@/lib/device-policy'; +import { useOfflineStore, type UserChoice } from './state'; + +const MB = 1024 * 1024; + +/** The windows a user picks from. Null keeps everything. */ +export const WINDOW_CHOICES: readonly (number | null)[] = [30, 90, 365, null]; +/** The largest attachment a user may keep, in MB. */ +export const ATTACHMENT_CAP_CHOICES: readonly number[] = [5, 25, 100, 500]; + +/** What the old offline mode kept, for those who had it on before the local store. */ +export const LEGACY_CHOICE: UserChoice = { on: true, days: 30, attachments: true, maxAttachmentMb: 5 }; + +export interface PlatformDefault { + on: boolean; + scope: StoreScope; +} + +export interface EffectiveScope { + account: string; + /** Whether the account keeps mail here at all. */ + enabled: boolean; + scope: StoreScope; + /** What the policy decides, for the settings page: these show "Set by your organisation". */ + locked: { + offline: boolean; + days: boolean; + attachments: boolean; + maxAttachment: boolean; + maxTotal: boolean; + }; +} + +/** The desktop app keeps mail without asking. Browsers stay opt-in. Feature-detected: the bridge is only there in the app. */ +export function offlineDefaultOn(): boolean { + return typeof window !== 'undefined' && Boolean((window as { bulwarkDesktop?: unknown }).bulwarkDesktop); +} + +export function platformDefault(): PlatformDefault { + return { on: offlineDefaultOn(), scope: DEFAULT_SCOPE }; +} + +/** Null means everything, so any cap is lower. */ +function cappedDays(days: number | null, cap: number): number | null { + if (!(cap > 0)) return days; + return days === null ? cap : Math.min(days, cap); +} + +function cappedBytes(bytes: number, capMb: number): number { + return capMb > 0 ? Math.min(bytes, capMb * MB) : bytes; +} + +export function effectiveScope( + account: string, + userChoice: UserChoice | null | undefined, + policy: Pick, + defaults: PlatformDefault, +): EffectiveScope { + const choice = userChoice ?? {}; + const days = choice.days !== undefined ? choice.days : defaults.scope.days; + const maxAttachment = choice.maxAttachmentMb !== undefined ? choice.maxAttachmentMb * MB : defaults.scope.maxAttachmentBytes; + return { + account, + enabled: !policy.noOffline && (choice.on ?? defaults.on), + scope: { + days: cappedDays(days, policy.offlineMaxDays), + attachments: !policy.noOfflineAttachments && (choice.attachments ?? defaults.scope.attachments), + maxAttachmentBytes: cappedBytes(maxAttachment, policy.offlineMaxAttachmentMb), + maxTotalBytes: cappedBytes(defaults.scope.maxTotalBytes, policy.offlineMaxTotalMb), + }, + locked: { + offline: policy.noOffline, + days: policy.offlineMaxDays > 0, + attachments: policy.noOfflineAttachments, + maxAttachment: policy.offlineMaxAttachmentMb > 0, + maxTotal: policy.offlineMaxTotalMb > 0, + }, + }; +} + +/** + * What the user chose for an account. The switch used to be the only thing + * stored, so an account that has it on and no choice yet was turned on under + * the old offline mode, and keeps the window it had. + */ +export function userChoiceFor(account: string): UserChoice | null { + const { choices, enabled } = useOfflineStore.getState(); + const stored = choices[account]; + const on = enabled.includes(account); + if (!stored) return on ? LEGACY_CHOICE : null; + return on && stored.on === undefined ? { ...stored, on } : stored; +} + +/** The windows on offer under a cap: the ones that fit, and the cap itself when it falls between them. */ +export function windowOptions(capDays: number): (number | null)[] { + if (!(capDays > 0)) return [...WINDOW_CHOICES]; + const fit = WINDOW_CHOICES.filter((days): days is number => days !== null && days < capDays); + return [...fit, capDays]; +} + +/** The attachment sizes on offer under a cap, in MB. */ +export function attachmentCapOptions(capMb: number): number[] { + if (!(capMb > 0)) return [...ATTACHMENT_CAP_CHOICES]; + const fit = ATTACHMENT_CAP_CHOICES.filter((mb) => mb < capMb); + return [...fit, capMb]; +} + +export function maxAttachmentMb(scope: StoreScope): number { + return Math.round(scope.maxAttachmentBytes / MB); +} + +/** A message older than the organisation's cap isn't kept, opened or not. */ +export function olderThanCap(receivedAt: unknown, capDays: number, now: number): boolean { + if (!(capDays > 0) || typeof receivedAt !== 'string') return false; + const at = Date.parse(receivedAt); + return Number.isFinite(at) && at < now - capDays * 86_400_000; +} diff --git a/lib/offline/state.ts b/lib/offline/state.ts index 1ba184282..fe2969d97 100644 --- a/lib/offline/state.ts +++ b/lib/offline/state.ts @@ -7,10 +7,50 @@ */ import { create } from 'zustand'; +import type { StoreUsage } from '@/lib/store/area'; import type { ConflictEntry, OutboxEntry, OutboxError } from './queue'; +import type { PersistState } from './storage-health'; +import type { SyncProgress } from './sync-progress'; /** localStorage: the local account ids that keep mail on this device. */ export const OFFLINE_ACCOUNTS_KEY = 'bulwark-offline-accounts'; +/** localStorage: what the user picked per account. Numbers and switches only. */ +export const OFFLINE_CHOICES_KEY = 'bulwark-offline-choices'; +/** localStorage: what's known about each account's store with the store gone. Numbers only, never content. */ +export const OFFLINE_HEALTH_KEY = 'bulwark-offline-health'; + +export interface UserChoice { + /** Off here means the user turned it off: the desktop app's default doesn't turn it back on. */ + on?: boolean; + /** Days of mail to keep. Null keeps everything. */ + days?: number | null; + attachments?: boolean; + maxAttachmentMb?: number; +} + +export interface AccountHealth { + /** The store was opened for this account once. */ + opened?: boolean; + /** Unsent messages and changes last counted: what an eviction loses. */ + pending?: number; + /** When the last sync finished. Survives a reload, unlike the running state. */ + lastSync?: number; + /** The browser deleted what was kept. Stays until the user has read it. */ + evicted?: { at: number; lost: number }; +} + +/** A calendar or contact edit that didn't go through. Lives in its own area's store. */ +export interface AreaConflict { + area: 'calendar' | 'contacts'; + account: string; + id: number; + createdAt: number; + title: string; + reason: 'refused' | 'changed' | 'gone'; + /** A delete can't be taken back, so it reads differently. */ + destroy: boolean; + detail: string | null; +} export interface OutboxRow { id: number; @@ -35,7 +75,18 @@ interface OfflineState { pendingChanges: number; /** Changes the server refused, or that met a message changed on another device. */ conflicts: ConflictEntry[]; + /** The same for calendar events and contacts. */ + areaConflicts: AreaConflict[]; usageBytes: number; + usage: Record; + choices: Record; + health: Record; + /** What the browser said about keeping this site's data. */ + persist: PersistState; + /** Accounts that couldn't write, and since when. Gone after the next good sync. */ + storageFull: Record; + /** How far the sync running for an account got. */ + progress: Record; /** Accounts whose mail is being brought onto the device right now. */ syncing: string[]; lastSyncedAt: Record; @@ -51,6 +102,25 @@ function readEnabled(): string[] { } } +function readRecord(key: string): Record { + try { + const raw = typeof localStorage === 'undefined' ? null : localStorage.getItem(key); + const parsed = raw ? JSON.parse(raw) : null; + return parsed && typeof parsed === 'object' && !Array.isArray(parsed) ? parsed as Record : {}; + } catch { + return {}; + } +} + +function writeRecord(key: string, value: Record): void { + try { + if (Object.keys(value).length > 0) localStorage.setItem(key, JSON.stringify(value)); + else localStorage.removeItem(key); + } catch { + /* storage unavailable */ + } +} + export const useOfflineStore = create()(() => ({ enabled: readEnabled(), browserOffline: typeof navigator !== 'undefined' && navigator.onLine === false, @@ -59,11 +129,58 @@ export const useOfflineStore = create()(() => ({ outbox: [], pendingChanges: 0, conflicts: [], + areaConflicts: [], usageBytes: 0, + usage: {}, + choices: readRecord(OFFLINE_CHOICES_KEY), + health: readRecord(OFFLINE_HEALTH_KEY), + persist: 'unknown', + storageFull: {}, + progress: {}, syncing: [], lastSyncedAt: {}, })); +export function writeChoice(account: string, patch: UserChoice): void { + const choices = { ...useOfflineStore.getState().choices, [account]: { ...useOfflineStore.getState().choices[account], ...patch } }; + useOfflineStore.setState({ choices }); + writeRecord(OFFLINE_CHOICES_KEY, choices); +} + +export function forgetAccountState(account: string): void { + const { choices, health, usage, storageFull, progress } = useOfflineStore.getState(); + const without = (record: Record) => Object.fromEntries(Object.entries(record).filter(([id]) => id !== account)); + const next = { choices: without(choices), health: without(health), usage: without(usage), storageFull: without(storageFull), progress: without(progress) }; + useOfflineStore.setState(next); + writeRecord(OFFLINE_CHOICES_KEY, next.choices); + writeRecord(OFFLINE_HEALTH_KEY, next.health); +} + +export function writeHealth(account: string, patch: AccountHealth): void { + const { health } = useOfflineStore.getState(); + const current = health[account]; + if (current && Object.entries(patch).every(([key, value]) => current[key as keyof AccountHealth] === value)) return; + const next = { ...health, [account]: { ...current, ...patch } }; + useOfflineStore.setState({ health: next }); + writeRecord(OFFLINE_HEALTH_KEY, next); +} + +/** The state of other tabs, after a storage event. */ +export function readStoredChoices(): Record { + return readRecord(OFFLINE_CHOICES_KEY); +} + +export function readStoredHealth(): Record { + return readRecord(OFFLINE_HEALTH_KEY); +} + +/** Nothing is kept for anyone any more. */ +export function forgetAllAccountState(): void { + useOfflineStore.setState({ choices: {}, health: {}, usage: {}, storageFull: {}, progress: {}, areaConflicts: [] }); + writeRecord(OFFLINE_CHOICES_KEY, {}); + writeRecord(OFFLINE_HEALTH_KEY, {}); +} + export function writeEnabled(enabled: string[]): void { useOfflineStore.setState({ enabled }); try { diff --git a/lib/offline/storage-health.ts b/lib/offline/storage-health.ts new file mode 100644 index 000000000..6205be58d --- /dev/null +++ b/lib/offline/storage-health.ts @@ -0,0 +1,60 @@ +/** + * The browser's side of keeping mail: whether it promised not to clear it, and + * whether it did anyway. Nothing here holds account content. + */ + +import { isStandaloneDisplayMode } from '@/lib/standalone-display'; +import { useOfflineStore } from './state'; + +export type PersistState = 'unknown' | 'granted' | 'refused' | 'unsupported'; + +/** + * Asks the browser not to clear this site's data when space runs low, and + * remembers the answer for the settings page. Chromium decides by itself and + * may say no until the app is installed; Firefox asks the user. + */ +export async function requestPersistence(): Promise { + let state: PersistState = 'unsupported'; + try { + if (typeof navigator.storage?.persist === 'function') state = (await navigator.storage.persist()) ? 'granted' : 'refused'; + } catch { + state = 'refused'; + } + useOfflineStore.setState({ persist: state }); + return state; +} + +/** What the browser last said, without asking. */ +export async function readPersistence(): Promise { + let state: PersistState = 'unsupported'; + try { + if (typeof navigator.storage?.persisted === 'function') state = (await navigator.storage.persisted()) ? 'granted' : 'refused'; + } catch { + state = 'unknown'; + } + useOfflineStore.setState({ persist: state }); + return state; +} + +/** + * Safari deletes a site's data after 7 days without a visit, unless the site is + * on the home screen or in the Dock. On iPhone and iPad every browser runs on + * the same engine, so Chrome and Firefox there count too. Chromium on a Mac or + * Windows, and the desktop app, say "Chrome" in the user agent. + */ +export function safariMayDelete(userAgent: string = typeof navigator === 'undefined' ? '' : navigator.userAgent, installed: boolean = isStandaloneDisplayMode()): boolean { + if (installed) return false; + if (!/AppleWebKit/.test(userAgent) || !/Version\/|CriOS|FxiOS|EdgiOS|OPiOS/.test(userAgent)) return false; + if (/iPhone|iPad|iPod/.test(userAgent)) return true; + return /Macintosh/.test(userAgent) && /Safari\//.test(userAgent) && !/Chrome|Chromium|Edg\/|OPR\//.test(userAgent); +} + +/** + * Whether the browser took away what was kept for an account: its key record + * with no file, or no key where one was made. A file with no key can't be read + * by anyone and is swept without a word; if the account had been opened, that + * is the second case. On a first open neither applies. + */ +export function wasEvicted(state: { opened: boolean; hadKey: boolean; fileExisted: boolean }): boolean { + return state.hadKey ? !state.fileExisted : state.opened; +} diff --git a/lib/offline/sync-progress.ts b/lib/offline/sync-progress.ts new file mode 100644 index 000000000..01c1db2e5 --- /dev/null +++ b/lib/offline/sync-progress.ts @@ -0,0 +1,60 @@ +/** + * How far a first sync got, and how long it may still take. The store reports + * batches of a phase: messages listed, then threads, then bodies, then files. + */ + +export interface SyncProgress { + area: string; + phase: string; + done: number; + total: number | null; + /** When this phase started here, and how far it was then. */ + startedAt: number; + startedDone: number; + at: number; +} + +/** + * Listing a message is about ten times as fast as fetching its body and + * indexing it (bench rig, 50,000 messages: 35 s to list, 400 s in all). So + * while listing, the time left includes the bodies that come after it. + */ +const BODY_COST_PER_LIST_ITEM = 10; +/** An estimate from less than this jumps about too much to show. */ +const MIN_SAMPLE_MS = 5_000; +/** Too small to be worth a progress line: new mail arriving in a normal pass. */ +const MIN_ITEMS_SHOWN = 50; + +export function nextProgress( + previous: SyncProgress | undefined, + event: { area: string; phase: string; done: number; total: number | null }, + now: number, +): SyncProgress { + const samePhase = previous?.area === event.area && previous.phase === event.phase && event.done >= previous.done; + return { + area: event.area, + phase: event.phase, + done: event.done, + total: event.total, + startedAt: samePhase ? previous.startedAt : now, + startedDone: samePhase ? previous.startedDone : event.done, + at: now, + }; +} + +export function progressWorthShowing(progress: SyncProgress | undefined): progress is SyncProgress { + return !!progress && (progress.total === null || progress.total >= MIN_ITEMS_SHOWN) && progress.done >= 0; +} + +/** Minutes left, rounded up; null while there's nothing sensible to say. */ +export function minutesLeft(progress: SyncProgress): number | null { + const { total, done, startedAt, startedDone, at } = progress; + if (total === null || total <= done) return null; + const elapsed = at - startedAt; + const moved = done - startedDone; + if (elapsed < MIN_SAMPLE_MS || moved <= 0) return null; + const perItem = elapsed / moved; + let left = (total - done) * perItem; + if (progress.phase === 'list') left += total * perItem * BODY_COST_PER_LIST_ITEM; + return Math.max(1, Math.ceil(left / 60_000)); +} diff --git a/lib/sign-out-cleanup.ts b/lib/sign-out-cleanup.ts index 9496e43d5..17534302b 100644 --- a/lib/sign-out-cleanup.ts +++ b/lib/sign-out-cleanup.ts @@ -36,6 +36,9 @@ const SIGNED_OUT_STORAGE_KEYS = [ // Offline mode's "Keep mail on this device" (lib/offline/state.ts): the // next person signing in here starts with it off. 'bulwark-offline-accounts', + // What each account chose to keep, and what's known about its store. + 'bulwark-offline-choices', + 'bulwark-offline-health', ]; const SIGNED_OUT_SIGNAL = 'bulwark:signed-out'; diff --git a/locales/ar/common.json b/locales/ar/common.json index ae8e0aa58..d27a9b2c9 100644 --- a/locales/ar/common.json +++ b/locales/ar/common.json @@ -5756,6 +5756,61 @@ "toast": "تغييرات أُجريت دون اتصال ولم تُطبَّق: {count}. يوضح صندوق الصادر أيها.", "storage_failed": "لم تعد هناك مساحة على هذا الجهاز للبريد دون اتصال. أفرغ مساحة أو احتفظ بأقل من الإعدادات." }, + "offlineStorage": { + "keep_description": "يحتفظ ببريدك وتقويمك وجهات اتصالك والملفات التي تختارها، مشفّرة في هذا المتصفح. دون اتصال يمكنك قراءة البريد ووضع علامات عليه ونقله، وما تكتبه ينتظر في صندوق الصادر. يؤدي تسجيل الخروج إلى إزالة كل ذلك.", + "window_label": "إلى أي مدة سابقة يُحتفظ بالبريد", + "window_description": "يُزال البريد وأحداث التقويم الأقدم من هذا الجهاز. ما زال بإمكانك فتحها عندما يكون لديك اتصال.", + "window_days": "{days, plural, zero {# يوم} one {يوم واحد} two {يومان} few {# أيام} many {# يومًا} other {# يوم}}", + "window_year": "سنة واحدة", + "window_everything": "الكل", + "attachments_label": "الاحتفاظ بالمرفقات", + "attachments_description": "مرفقات الرسائل المحفوظة والملفات التي تحتفظ بها دون اتصال، حتى {total} في المجموع. تُزال الأقدم أولًا.", + "total_locked": "تسمح مؤسستك بحد أقصى {size} من المرفقات والملفات.", + "attachment_cap_label": "أكبر مرفق يُحتفظ به", + "usage_mail": "الرسائل وفهرس البحث", + "usage_attachments": "المرفقات", + "usage_calendar": "التقويم", + "usage_contacts": "جهات الاتصال", + "usage_files": "الملفات المحفوظة دون اتصال", + "usage_row": "{size} ({count, plural, zero {# عنصر} one {عنصر واحد} two {عنصران} few {# عناصر} many {# عنصرًا} other {# عنصر}})", + "progress_list": "جارٍ سرد الرسائل", + "progress_bodies": "جارٍ تنزيل الرسائل", + "progress_threads": "جارٍ ترتيب المحادثات", + "progress_files": "جارٍ تنزيل الملفات", + "progress_other": "جارٍ جلب البيانات إلى هذا الجهاز", + "progress_count": "{done} من {total}", + "progress_count_open": "{done} حتى الآن", + "progress_left": "متبقٍّ نحو {minutes, plural, zero {# دقيقة} one {دقيقة واحدة} two {دقيقتين} few {# دقائق} many {# دقيقة} other {# دقيقة}}", + "clear_label": "مسح هذا الحساب", + "clear_description": "يحذف كل ما يحتفظ به هذا الجهاز لهذا الحساب، ثم ينزّله من جديد.", + "clear_button": "مسح…", + "clear_confirm_title": "هل تريد مسح هذا الحساب على هذا الجهاز؟", + "clear_confirm_message": "سيُحذف كل ما يحتفظ به هذا الجهاز لهذا الحساب ثم يُنزَّل من جديد. يبقى بريدك على الخادم.", + "clear_confirm_unsent": "{count, plural, zero {لن تُفقد أي رسالة لم تُرسل.} one {ستُفقد رسالة واحدة لم تُرسل.} two {ستُفقد رسالتان لم تُرسلا.} few {ستُفقد # رسائل لم تُرسل.} many {ستُفقد # رسالة لم تُرسل.} other {ستُفقد # رسالة لم تُرسل.}}", + "clear_confirm": "مسح", + "persist_refused": "قد يحذف هذا المتصفح البريد المحفوظ عندما تقل المساحة. تثبيت التطبيق يمنع ذلك عادةً.", + "persist_retry": "اسأل مرة أخرى", + "safari_hint": "يحذف Safari بيانات الموقع بعد 7 أيام دون زيارة. أضف Bulwark إلى الشاشة الرئيسية أو إلى Dock لتبقى رسائلك على هذا الجهاز.", + "evicted": "حذف المتصفح البريد المحفوظ على هذا الجهاز. يجري تنزيله من جديد.", + "evicted_lost": "{count, plural, zero {لم تُفقد أي رسالة أو تغيير لم يُرسل.} one {فُقدت رسالة أو تغيير واحد لم يُرسل.} two {فُقدت رسالتان أو تغييران لم يُرسلا.} few {فُقدت # رسائل أو تغييرات لم تُرسل.} many {فُقدت # رسالة أو تغييرًا لم يُرسل.} other {فُقدت # رسالة أو تغيير لم يُرسل.}}", + "evicted_dismiss": "حسنًا", + "storage_full_title": "مساحة تخزين الجهاز ممتلئة.", + "storage_full_text": "توقف Bulwark عن حفظ البريد هنا. احتفظ ببريد أقل أو امسح هذا الحساب لتوفير مساحة.", + "open_settings": "فتح الإعدادات", + "default_on": "يحتفظ Bulwark ببريدك على هذا الجهاز ليعمل دون اتصال. يمكنك تغيير ذلك من الإعدادات.", + "conflict_calendar": "حدث في التقويم", + "conflict_contacts": "جهة اتصال", + "kept_files_title": "الملفات المحفوظة دون اتصال", + "kept_state_kept": "على هذا الجهاز", + "kept_state_waiting": "بانتظار التنزيل", + "kept_error_tooLarge": "كبير جدًا للاحتفاظ به", + "kept_error_overLimit": "يتجاوز حد هذا الجهاز", + "kept_error_notAllowed": "لا تسمح مؤسستك بالاحتفاظ بالملفات", + "kept_error_download": "تعذّر التنزيل", + "keep_offline": "الاحتفاظ دون اتصال", + "unpin": "إيقاف الاحتفاظ دون اتصال", + "unpin_label": "إيقاف الاحتفاظ بـ {name} دون اتصال" + }, "deep_link": { "message_not_found": "لم تعد هذه الرسالة متاحة.", "thread_not_found": "لم تعد هذه المحادثة متاحة.", diff --git a/locales/ca/common.json b/locales/ca/common.json index ce62318b7..e9c57770f 100644 --- a/locales/ca/common.json +++ b/locales/ca/common.json @@ -5756,6 +5756,61 @@ "toast": "Canvis fets sense connexió que no s'han aplicat: {count}. La safata de sortida indica quins.", "storage_failed": "Aquest dispositiu no té més espai per al correu sense connexió. Allibereu espai o conserveu-ne menys a la configuració." }, + "offlineStorage": { + "keep_description": "Desa el vostre correu, calendari, contactes i els fitxers que trieu, xifrats en aquest navegador. Sense connexió podeu llegir, marcar i moure correu, i el que escriviu espera a la safata de sortida. En tancar la sessió s'esborra tot.", + "window_label": "Fins a quan enrere desar", + "window_description": "El correu i els esdeveniments més antics surten d'aquest dispositiu. Encara els podeu obrir quan tingueu connexió.", + "window_days": "{days, plural, one {# dia} other {# dies}}", + "window_year": "1 any", + "window_everything": "Tot", + "attachments_label": "Desa els fitxers adjunts", + "attachments_description": "Fitxers adjunts dels missatges desats i fitxers que deseu sense connexió, fins a {total} en total. Els més antics se suprimeixen primer.", + "total_locked": "La vostra organització permet com a màxim {size} d'adjunts i fitxers.", + "attachment_cap_label": "Adjunt més gran que es desa", + "usage_mail": "Missatges i índex de cerca", + "usage_attachments": "Fitxers adjunts", + "usage_calendar": "Calendari", + "usage_contacts": "Contactes", + "usage_files": "Fitxers desats sense connexió", + "usage_row": "{size} ({count, plural, one {# element} other {# elements}})", + "progress_list": "Llistant els missatges", + "progress_bodies": "Baixant els missatges", + "progress_threads": "Ordenant les converses", + "progress_files": "Baixant els fitxers", + "progress_other": "Portant dades a aquest dispositiu", + "progress_count": "{done} de {total}", + "progress_count_open": "{done} fins ara", + "progress_left": "queden uns {minutes, plural, one {# minut} other {# minuts}}", + "clear_label": "Buida aquest compte", + "clear_description": "Suprimeix tot el que aquest dispositiu desa d'aquest compte i ho torna a baixar.", + "clear_button": "Buida…", + "clear_confirm_title": "Voleu buidar aquest compte en aquest dispositiu?", + "clear_confirm_message": "Tot el que aquest dispositiu desa d'aquest compte se suprimeix i es torna a baixar. El vostre correu al servidor no es toca.", + "clear_confirm_unsent": "{count, plural, one {Es perdrà # missatge sense enviar.} other {Es perdran # missatges sense enviar.}}", + "clear_confirm": "Buida", + "persist_refused": "Aquest navegador pot esborrar el correu desat quan falti espai. Instal·lar l'aplicació sol evitar-ho.", + "persist_retry": "Torna-ho a demanar", + "safari_hint": "El Safari esborra les dades d'un lloc després de 7 dies sense visitar-lo. Afegiu Bulwark a la pantalla d'inici o al Dock per mantenir el vostre correu en aquest dispositiu.", + "evicted": "El navegador ha esborrat el correu desat en aquest dispositiu. Es torna a baixar.", + "evicted_lost": "{count, plural, one {S'ha perdut # missatge o canvi sense enviar.} other {S'han perdut # missatges o canvis sense enviar.}}", + "evicted_dismiss": "D'acord", + "storage_full_title": "L'emmagatzematge del dispositiu és ple.", + "storage_full_text": "Bulwark ha deixat de desar correu aquí. Deseu menys correu o buideu aquest compte per fer espai.", + "open_settings": "Obre la configuració", + "default_on": "Bulwark desa el vostre correu en aquest dispositiu perquè funcioni sense connexió. Podeu canviar-ho a la configuració.", + "conflict_calendar": "Esdeveniment del calendari", + "conflict_contacts": "Contacte", + "kept_files_title": "Fitxers desats sense connexió", + "kept_state_kept": "En aquest dispositiu", + "kept_state_waiting": "Esperant la baixada", + "kept_error_tooLarge": "Massa gran per desar-lo", + "kept_error_overLimit": "Supera el límit d'aquest dispositiu", + "kept_error_notAllowed": "La vostra organització no permet desar fitxers", + "kept_error_download": "No s'ha pogut baixar", + "keep_offline": "Desa sense connexió", + "unpin": "Deixa de desar sense connexió", + "unpin_label": "Deixa de desar {name} sense connexió" + }, "deep_link": { "message_not_found": "Aquest missatge ja no està disponible.", "thread_not_found": "Aquesta conversa ja no està disponible.", diff --git a/locales/cs/common.json b/locales/cs/common.json index a37357845..da3998c40 100644 --- a/locales/cs/common.json +++ b/locales/cs/common.json @@ -5756,6 +5756,61 @@ "toast": "Nepoužité změny provedené offline: {count}. Které to jsou, ukazuje pošta k odeslání.", "storage_failed": "Na tomto zařízení už není místo pro poštu offline. Uvolněte místo nebo v nastavení ponechte méně." }, + "offlineStorage": { + "keep_description": "Uchovává vaši poštu, kalendář, kontakty a vybrané soubory zašifrované v tomto prohlížeči. Offline můžete poštu číst, označovat a přesouvat a to, co napíšete, čeká v odesílané poště. Odhlášení vše odstraní.", + "window_label": "Jak dlouho do minulosti uchovávat", + "window_description": "Starší pošta a události z kalendáře toto zařízení opustí. Když budete online, můžete je stále otevřít.", + "window_days": "{days, plural, one {# den} few {# dny} many {# dne} other {# dní}}", + "window_year": "1 rok", + "window_everything": "Vše", + "attachments_label": "Uchovávat přílohy", + "attachments_description": "Přílohy uchovaných zpráv a soubory, které uchováváte offline, celkem až {total}. Nejstarší se odstraní jako první.", + "total_locked": "Vaše organizace povoluje nejvýše {size} příloh a souborů.", + "attachment_cap_label": "Největší uchovávaná příloha", + "usage_mail": "Zprávy a index vyhledávání", + "usage_attachments": "Přílohy", + "usage_calendar": "Kalendář", + "usage_contacts": "Kontakty", + "usage_files": "Soubory uchované offline", + "usage_row": "{size} ({count, plural, one {# položka} few {# položky} many {# položky} other {# položek}})", + "progress_list": "Vypisují se zprávy", + "progress_bodies": "Stahují se zprávy", + "progress_threads": "Řadí se konverzace", + "progress_files": "Stahují se soubory", + "progress_other": "Přenášejí se data do tohoto zařízení", + "progress_count": "{done} z {total}", + "progress_count_open": "zatím {done}", + "progress_left": "zbývá asi {minutes, plural, one {# minuta} few {# minuty} many {# minuty} other {# minut}}", + "clear_label": "Vymazat tento účet", + "clear_description": "Smaže vše, co toto zařízení pro tento účet uchovává, a stáhne to znovu.", + "clear_button": "Vymazat…", + "clear_confirm_title": "Vymazat tento účet na tomto zařízení?", + "clear_confirm_message": "Vše, co toto zařízení pro tento účet uchovává, se smaže a stáhne znovu. Vaše pošta na serveru zůstane.", + "clear_confirm_unsent": "{count, plural, one {# neodeslaná zpráva se ztratí.} few {# neodeslané zprávy se ztratí.} many {# neodeslané zprávy se ztratí.} other {# neodeslaných zpráv se ztratí.}}", + "clear_confirm": "Vymazat", + "persist_refused": "Tento prohlížeč může uchovanou poštu smazat, když dojde místo. Instalace aplikace tomu obvykle zabrání.", + "persist_retry": "Zeptat se znovu", + "safari_hint": "Safari smaže data webu po 7 dnech bez návštěvy. Přidejte Bulwark na plochu nebo do Docku, aby vaše pošta na tomto zařízení zůstala.", + "evicted": "Prohlížeč smazal poštu uchovanou na tomto zařízení. Stahuje se znovu.", + "evicted_lost": "{count, plural, one {# neodeslaná zpráva nebo změna se ztratila.} few {# neodeslané zprávy nebo změny se ztratily.} many {# neodeslané zprávy nebo změny se ztratily.} other {# neodeslaných zpráv nebo změn se ztratilo.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Úložiště zařízení je plné.", + "storage_full_text": "Bulwark sem přestal ukládat poštu. Uchovávejte méně pošty nebo vymažte tento účet, aby se uvolnilo místo.", + "open_settings": "Otevřít nastavení", + "default_on": "Bulwark uchovává vaši poštu na tomto zařízení, aby fungoval i bez připojení. Můžete to změnit v Nastavení.", + "conflict_calendar": "Událost v kalendáři", + "conflict_contacts": "Kontakt", + "kept_files_title": "Soubory uchované offline", + "kept_state_kept": "Na tomto zařízení", + "kept_state_waiting": "Čeká na stažení", + "kept_error_tooLarge": "Příliš velký k uchování", + "kept_error_overLimit": "Přes limit tohoto zařízení", + "kept_error_notAllowed": "Vaše organizace uchovávání souborů nepovoluje", + "kept_error_download": "Nepodařilo se stáhnout", + "keep_offline": "Uchovat offline", + "unpin": "Přestat uchovávat offline", + "unpin_label": "Přestat uchovávat {name} offline" + }, "deep_link": { "message_not_found": "Tato zpráva už není dostupná.", "thread_not_found": "Tato konverzace už není dostupná.", diff --git a/locales/da/common.json b/locales/da/common.json index b024c725c..7ecfa2e82 100644 --- a/locales/da/common.json +++ b/locales/da/common.json @@ -5756,6 +5756,61 @@ "toast": "Ændringer lavet offline, der ikke blev gennemført: {count}. Udbakken viser hvilke.", "storage_failed": "Denne enhed har ikke mere plads til offlinemail. Frigør plads, eller behold mindre i indstillingerne." }, + "offlineStorage": { + "keep_description": "Beholder din mail, kalender, dine kontakter og de filer, du vælger, krypteret i denne browser. Offline kan du læse, markere og flytte mail, og det, du skriver, venter i udbakken. Når du logger ud, fjernes det hele.", + "window_label": "Hvor langt tilbage der beholdes", + "window_description": "Ældre mail og kalenderbegivenheder forlader denne enhed. Du kan stadig åbne dem, når du har forbindelse.", + "window_days": "{days, plural, one {# dag} other {# dage}}", + "window_year": "1 år", + "window_everything": "Alt", + "attachments_label": "Behold vedhæftede filer", + "attachments_description": "Vedhæftede filer fra beholdte beskeder og de filer, du beholder offline, op til {total} i alt. De ældste fjernes først.", + "total_locked": "Din organisation tillader højst {size} vedhæftede filer og filer.", + "attachment_cap_label": "Største vedhæftede fil, der beholdes", + "usage_mail": "Beskeder og søgeindeks", + "usage_attachments": "Vedhæftede filer", + "usage_calendar": "Kalender", + "usage_contacts": "Kontakter", + "usage_files": "Filer beholdt offline", + "usage_row": "{size} ({count, plural, one {# element} other {# elementer}})", + "progress_list": "Lister beskeder", + "progress_bodies": "Henter beskeder", + "progress_threads": "Sorterer samtaler", + "progress_files": "Henter filer", + "progress_other": "Henter data til denne enhed", + "progress_count": "{done} af {total}", + "progress_count_open": "{done} indtil nu", + "progress_left": "cirka {minutes, plural, one {# minut} other {# minutter}} tilbage", + "clear_label": "Ryd denne konto", + "clear_description": "Sletter alt, denne enhed beholder for denne konto, og henter det derefter igen.", + "clear_button": "Ryd…", + "clear_confirm_title": "Ryd denne konto på denne enhed?", + "clear_confirm_message": "Alt, denne enhed beholder for denne konto, slettes og hentes igen. Din mail på serveren bliver liggende.", + "clear_confirm_unsent": "{count, plural, one {# usendt besked går tabt.} other {# usendte beskeder går tabt.}}", + "clear_confirm": "Ryd", + "persist_refused": "Denne browser kan slette den beholdte mail, når pladsen bliver knap. Det hjælper normalt at installere appen.", + "persist_retry": "Spørg igen", + "safari_hint": "Safari sletter et websteds data efter 7 dage uden besøg. Føj Bulwark til din hjemmeskærm eller til Dock for at beholde din mail på denne enhed.", + "evicted": "Browseren slettede den mail, der var beholdt på denne enhed. Den hentes igen.", + "evicted_lost": "{count, plural, one {# usendt besked eller ændring gik tabt.} other {# usendte beskeder eller ændringer gik tabt.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Enhedens lager er fuldt.", + "storage_full_text": "Bulwark er holdt op med at gemme mail her. Behold mindre mail, eller ryd denne konto for at frigøre plads.", + "open_settings": "Åbn indstillinger", + "default_on": "Bulwark beholder din mail på denne enhed, så den virker uden forbindelse. Du kan ændre det i Indstillinger.", + "conflict_calendar": "Kalenderbegivenhed", + "conflict_contacts": "Kontakt", + "kept_files_title": "Filer beholdt offline", + "kept_state_kept": "På denne enhed", + "kept_state_waiting": "Venter på download", + "kept_error_tooLarge": "For stor til at beholde", + "kept_error_overLimit": "Over grænsen for denne enhed", + "kept_error_notAllowed": "Din organisation tillader ikke, at filer beholdes", + "kept_error_download": "Kunne ikke hentes", + "keep_offline": "Behold offline", + "unpin": "Behold ikke længere offline", + "unpin_label": "Behold ikke {name} offline længere" + }, "deep_link": { "message_not_found": "Denne besked er ikke længere tilgængelig.", "thread_not_found": "Denne samtale er ikke længere tilgængelig.", diff --git a/locales/de/common.json b/locales/de/common.json index 2dc411640..001c5ba3b 100644 --- a/locales/de/common.json +++ b/locales/de/common.json @@ -5756,6 +5756,61 @@ "toast": "Offline gemachte Änderungen wurden nicht übernommen: {count}. Welche, steht im Postausgang.", "storage_failed": "Auf diesem Gerät ist kein Platz mehr für Offline-E-Mails. Geben Sie Speicher frei oder behalten Sie in den Einstellungen weniger." }, + "offlineStorage": { + "keep_description": "Behält Ihre E-Mails, Ihren Kalender, Ihre Kontakte und ausgewählte Dateien verschlüsselt in diesem Browser. Offline können Sie E-Mails lesen, markieren und verschieben, und was Sie schreiben, wartet im Postausgang. Beim Abmelden wird alles entfernt.", + "window_label": "Wie weit zurück behalten", + "window_description": "Ältere E-Mails und Kalendertermine werden von diesem Gerät entfernt. Sie können sie weiterhin öffnen, solange Sie online sind.", + "window_days": "{days, plural, one {# Tag} other {# Tage}}", + "window_year": "1 Jahr", + "window_everything": "Alles", + "attachments_label": "Anhänge behalten", + "attachments_description": "Anhänge behaltener Nachrichten und die Dateien, die Sie offline behalten, insgesamt bis zu {total}. Die ältesten werden zuerst entfernt.", + "total_locked": "Ihre Organisation erlaubt höchstens {size} für Anhänge und Dateien.", + "attachment_cap_label": "Größter Anhang, der behalten wird", + "usage_mail": "Nachrichten und Suchindex", + "usage_attachments": "Anhänge", + "usage_calendar": "Kalender", + "usage_contacts": "Kontakte", + "usage_files": "Offline behaltene Dateien", + "usage_row": "{size} ({count, plural, one {# Element} other {# Elemente}})", + "progress_list": "Nachrichten werden aufgelistet", + "progress_bodies": "Nachrichten werden geladen", + "progress_threads": "Unterhaltungen werden sortiert", + "progress_files": "Dateien werden geladen", + "progress_other": "Daten werden auf dieses Gerät geholt", + "progress_count": "{done} von {total}", + "progress_count_open": "bisher {done}", + "progress_left": "noch etwa {minutes, plural, one {# Minute} other {# Minuten}}", + "clear_label": "Dieses Konto leeren", + "clear_description": "Löscht alles, was dieses Gerät für dieses Konto behält, und lädt es danach neu.", + "clear_button": "Leeren…", + "clear_confirm_title": "Dieses Konto auf diesem Gerät leeren?", + "clear_confirm_message": "Alles, was dieses Gerät für dieses Konto behält, wird gelöscht und neu geladen. Ihre E-Mails auf dem Server bleiben erhalten.", + "clear_confirm_unsent": "{count, plural, one {# ungesendete Nachricht geht verloren.} other {# ungesendete Nachrichten gehen verloren.}}", + "clear_confirm": "Leeren", + "persist_refused": "Dieser Browser kann die behaltenen E-Mails löschen, wenn der Platz knapp wird. Die App zu installieren verhindert das meistens.", + "persist_retry": "Erneut fragen", + "safari_hint": "Safari löscht die Daten einer Website nach 7 Tagen ohne Besuch. Fügen Sie Bulwark zum Home-Bildschirm oder zum Dock hinzu, damit Ihre E-Mails auf diesem Gerät bleiben.", + "evicted": "Der Browser hat die auf diesem Gerät behaltenen E-Mails gelöscht. Sie werden neu geladen.", + "evicted_lost": "{count, plural, one {# ungesendete Nachricht oder Änderung ging verloren.} other {# ungesendete Nachrichten oder Änderungen gingen verloren.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Der Speicher des Geräts ist voll.", + "storage_full_text": "Bulwark speichert hier keine E-Mails mehr. Behalten Sie weniger E-Mails oder leeren Sie dieses Konto, um Platz zu schaffen.", + "open_settings": "Einstellungen öffnen", + "default_on": "Bulwark behält Ihre E-Mails auf diesem Gerät, damit es auch ohne Verbindung funktioniert. Sie können das in den Einstellungen ändern.", + "conflict_calendar": "Kalendertermin", + "conflict_contacts": "Kontakt", + "kept_files_title": "Offline behaltene Dateien", + "kept_state_kept": "Auf diesem Gerät", + "kept_state_waiting": "Wartet auf den Download", + "kept_error_tooLarge": "Zu groß zum Behalten", + "kept_error_overLimit": "Über dem Limit für dieses Gerät", + "kept_error_notAllowed": "Ihre Organisation erlaubt das Behalten von Dateien nicht", + "kept_error_download": "Konnte nicht geladen werden", + "keep_offline": "Offline behalten", + "unpin": "Nicht mehr offline behalten", + "unpin_label": "{name} nicht mehr offline behalten" + }, "deep_link": { "message_not_found": "Diese Nachricht ist nicht mehr verfügbar.", "thread_not_found": "Diese Unterhaltung ist nicht mehr verfügbar.", diff --git a/locales/en/common.json b/locales/en/common.json index fdb1eac13..2093b56e6 100644 --- a/locales/en/common.json +++ b/locales/en/common.json @@ -5756,6 +5756,61 @@ "toast": "Changes you made offline weren't applied: {count}. The outbox shows which.", "storage_failed": "This device has no room left for offline mail. Free up space, or keep less in Settings." }, + "offlineStorage": { + "keep_description": "Keeps your mail, calendar, contacts and chosen files encrypted in this browser. Offline you can read, flag and move mail, and what you write waits in the outbox. Signing out removes all of it.", + "window_label": "How far back to keep", + "window_description": "Older mail and calendar events leave this device. You can still open them when you have a connection.", + "window_days": "{days, plural, one {# day} other {# days}}", + "window_year": "1 year", + "window_everything": "Everything", + "attachments_label": "Keep attachments", + "attachments_description": "Attachments of kept messages and the files you keep offline, up to {total} in all. The oldest go first.", + "total_locked": "Your organisation allows {size} of attachments and files at most.", + "attachment_cap_label": "Largest attachment to keep", + "usage_mail": "Messages and search index", + "usage_attachments": "Attachments", + "usage_calendar": "Calendar", + "usage_contacts": "Contacts", + "usage_files": "Files kept offline", + "usage_row": "{size} ({count, plural, one {# item} other {# items}})", + "progress_list": "Listing messages", + "progress_bodies": "Downloading messages", + "progress_threads": "Sorting conversations", + "progress_files": "Downloading files", + "progress_other": "Bringing data to this device", + "progress_count": "{done} of {total}", + "progress_count_open": "{done} so far", + "progress_left": "about {minutes, plural, one {# minute} other {# minutes}} left", + "clear_label": "Clear this account", + "clear_description": "Deletes everything this device keeps for this account, then downloads it again.", + "clear_button": "Clear…", + "clear_confirm_title": "Clear this account on this device?", + "clear_confirm_message": "Everything this device keeps for this account is deleted and downloaded again. Your mail on the server stays.", + "clear_confirm_unsent": "{count, plural, one {# unsent message is lost.} other {# unsent messages are lost.}}", + "clear_confirm": "Clear", + "persist_refused": "This browser may delete the kept mail when space runs low. Installing the app usually stops that.", + "persist_retry": "Ask again", + "safari_hint": "Safari deletes a site's data after 7 days without a visit. Add Bulwark to your Home Screen or Dock to keep your mail on this device.", + "evicted": "The browser deleted the mail kept on this device. It's downloading again.", + "evicted_lost": "{count, plural, one {# unsent message or change was lost.} other {# unsent messages or changes were lost.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Device storage is full.", + "storage_full_text": "Bulwark has stopped saving mail here. Keep less mail or clear this account to make room.", + "open_settings": "Open settings", + "default_on": "Bulwark keeps your mail on this device, so it works without a connection. You can change this in Settings.", + "conflict_calendar": "Calendar event", + "conflict_contacts": "Contact", + "kept_files_title": "Files kept offline", + "kept_state_kept": "On this device", + "kept_state_waiting": "Waiting to download", + "kept_error_tooLarge": "Too large to keep", + "kept_error_overLimit": "Over the limit for this device", + "kept_error_notAllowed": "Your organisation doesn't allow keeping files", + "kept_error_download": "Couldn't be downloaded", + "keep_offline": "Keep offline", + "unpin": "Stop keeping offline", + "unpin_label": "Stop keeping {name} offline" + }, "deep_link": { "message_not_found": "This message is no longer available.", "thread_not_found": "This conversation is no longer available.", diff --git a/locales/es/common.json b/locales/es/common.json index 7b90943c5..c2246b552 100644 --- a/locales/es/common.json +++ b/locales/es/common.json @@ -5756,6 +5756,61 @@ "toast": "Cambios hechos sin conexión que no se aplicaron: {count}. La bandeja de salida indica cuáles.", "storage_failed": "Este dispositivo no tiene espacio para el correo sin conexión. Libera espacio o guarda menos en Ajustes." }, + "offlineStorage": { + "keep_description": "Guarda tu correo, tu calendario, tus contactos y los archivos que elijas, cifrados en este navegador. Sin conexión puedes leer, marcar y mover correo, y lo que escribas espera en la bandeja de salida. Al cerrar sesión se borra todo.", + "window_label": "Cuánto tiempo atrás guardar", + "window_description": "El correo y los eventos más antiguos salen de este dispositivo. Aún puedes abrirlos cuando tengas conexión.", + "window_days": "{days, plural, one {# día} other {# días}}", + "window_year": "1 año", + "window_everything": "Todo", + "attachments_label": "Guardar adjuntos", + "attachments_description": "Adjuntos de los mensajes guardados y archivos que guardas sin conexión, hasta {total} en total. Los más antiguos se eliminan primero.", + "total_locked": "Tu organización permite como máximo {size} de adjuntos y archivos.", + "attachment_cap_label": "Adjunto más grande que se guarda", + "usage_mail": "Mensajes e índice de búsqueda", + "usage_attachments": "Adjuntos", + "usage_calendar": "Calendario", + "usage_contacts": "Contactos", + "usage_files": "Archivos guardados sin conexión", + "usage_row": "{size} ({count, plural, one {# elemento} other {# elementos}})", + "progress_list": "Listando mensajes", + "progress_bodies": "Descargando mensajes", + "progress_threads": "Ordenando conversaciones", + "progress_files": "Descargando archivos", + "progress_other": "Trayendo datos a este dispositivo", + "progress_count": "{done} de {total}", + "progress_count_open": "{done} hasta ahora", + "progress_left": "faltan unos {minutes, plural, one {# minuto} other {# minutos}}", + "clear_label": "Vaciar esta cuenta", + "clear_description": "Elimina todo lo que este dispositivo guarda de esta cuenta y lo vuelve a descargar.", + "clear_button": "Vaciar…", + "clear_confirm_title": "¿Vaciar esta cuenta en este dispositivo?", + "clear_confirm_message": "Todo lo que este dispositivo guarda de esta cuenta se elimina y se vuelve a descargar. Tu correo en el servidor se mantiene.", + "clear_confirm_unsent": "{count, plural, one {Se perderá # mensaje sin enviar.} other {Se perderán # mensajes sin enviar.}}", + "clear_confirm": "Vaciar", + "persist_refused": "Este navegador puede borrar el correo guardado cuando falte espacio. Instalar la aplicación suele evitarlo.", + "persist_retry": "Preguntar de nuevo", + "safari_hint": "Safari borra los datos de un sitio tras 7 días sin visitarlo. Añade Bulwark a tu pantalla de inicio o al Dock para conservar tu correo en este dispositivo.", + "evicted": "El navegador borró el correo guardado en este dispositivo. Se está descargando de nuevo.", + "evicted_lost": "{count, plural, one {Se perdió # mensaje o cambio sin enviar.} other {Se perdieron # mensajes o cambios sin enviar.}}", + "evicted_dismiss": "OK", + "storage_full_title": "El almacenamiento del dispositivo está lleno.", + "storage_full_text": "Bulwark ha dejado de guardar correo aquí. Guarda menos correo o vacía esta cuenta para liberar espacio.", + "open_settings": "Abrir ajustes", + "default_on": "Bulwark guarda tu correo en este dispositivo para que funcione sin conexión. Puedes cambiarlo en Ajustes.", + "conflict_calendar": "Evento del calendario", + "conflict_contacts": "Contacto", + "kept_files_title": "Archivos guardados sin conexión", + "kept_state_kept": "En este dispositivo", + "kept_state_waiting": "Esperando la descarga", + "kept_error_tooLarge": "Demasiado grande para guardarlo", + "kept_error_overLimit": "Supera el límite de este dispositivo", + "kept_error_notAllowed": "Tu organización no permite guardar archivos", + "kept_error_download": "No se pudo descargar", + "keep_offline": "Guardar sin conexión", + "unpin": "Dejar de guardar sin conexión", + "unpin_label": "Dejar de guardar {name} sin conexión" + }, "deep_link": { "message_not_found": "Este mensaje ya no está disponible.", "thread_not_found": "Esta conversación ya no está disponible.", diff --git a/locales/et/common.json b/locales/et/common.json index a6b5b5eb2..289a223d8 100644 --- a/locales/et/common.json +++ b/locales/et/common.json @@ -5756,6 +5756,61 @@ "toast": "Võrguühenduseta tehtud rakendamata muudatused: {count}. Väljundkaust näitab, millised.", "storage_failed": "Selles seadmes pole enam ruumi võrguühenduseta kirjade jaoks. Vabastage ruumi või hoidke seadetes vähem." }, + "offlineStorage": { + "keep_description": "Hoiab sinu kirju, kalendrit, kontakte ja valitud faile krüptitult selles brauseris. Võrguta saad kirju lugeda, märgistada ja teisaldada ning see, mida kirjutad, ootab väljuvate kirjade kastis. Välja logides eemaldatakse kõik.", + "window_label": "Kui kaugele minevikku hoida", + "window_description": "Vanemad kirjad ja kalendrisündmused kaovad sellest seadmest. Saad neid endiselt avada, kui oled võrgus.", + "window_days": "{days, plural, one {# päev} other {# päeva}}", + "window_year": "1 aasta", + "window_everything": "Kõik", + "attachments_label": "Hoia manuseid", + "attachments_description": "Hoitud kirjade manused ja failid, mida hoiad võrguta, kokku kuni {total}. Vanimad eemaldatakse esimesena.", + "total_locked": "Sinu organisatsioon lubab manuseid ja faile kokku kuni {size}.", + "attachment_cap_label": "Suurim hoitav manus", + "usage_mail": "Kirjad ja otsinguindeks", + "usage_attachments": "Manused", + "usage_calendar": "Kalender", + "usage_contacts": "Kontaktid", + "usage_files": "Võrguta hoitud failid", + "usage_row": "{size} ({count, plural, one {# kirje} other {# kirjet}})", + "progress_list": "Kirjade loendamine", + "progress_bodies": "Kirjade allalaadimine", + "progress_threads": "Vestluste sortimine", + "progress_files": "Failide allalaadimine", + "progress_other": "Andmete toomine sellesse seadmesse", + "progress_count": "{done} / {total}", + "progress_count_open": "seni {done}", + "progress_left": "jäänud umbes {minutes, plural, one {# minut} other {# minutit}}", + "clear_label": "Tühjenda see konto", + "clear_description": "Kustutab kõik, mida see seade selle konto jaoks hoiab, ja laadib selle uuesti alla.", + "clear_button": "Tühjenda…", + "clear_confirm_title": "Kas tühjendada see konto selles seadmes?", + "clear_confirm_message": "Kõik, mida see seade selle konto jaoks hoiab, kustutatakse ja laaditakse uuesti alla. Sinu kirjad serveris jäävad alles.", + "clear_confirm_unsent": "{count, plural, one {# saatmata kiri läheb kaotsi.} other {# saatmata kirja lähevad kaotsi.}}", + "clear_confirm": "Tühjenda", + "persist_refused": "See brauser võib hoitud kirjad kustutada, kui ruumi napib. Rakenduse paigaldamine hoiab selle tavaliselt ära.", + "persist_retry": "Küsi uuesti", + "safari_hint": "Safari kustutab saidi andmed, kui seda pole 7 päeva külastatud. Lisa Bulwark avaekraanile või Dockile, et su kirjad sellesse seadmesse alles jääksid.", + "evicted": "Brauser kustutas selles seadmes hoitud kirjad. Need laaditakse uuesti alla.", + "evicted_lost": "{count, plural, one {# saatmata kiri või muudatus läks kaotsi.} other {# saatmata kirja või muudatust läks kaotsi.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Seadme salvestusruum on täis.", + "storage_full_text": "Bulwark ei salvesta siin enam kirju. Hoia vähem kirju või tühjenda see konto, et ruumi vabastada.", + "open_settings": "Ava seaded", + "default_on": "Bulwark hoiab su kirju selles seadmes, et see töötaks ka ilma ühenduseta. Saad seda seadetes muuta.", + "conflict_calendar": "Kalendrisündmus", + "conflict_contacts": "Kontakt", + "kept_files_title": "Võrguta hoitud failid", + "kept_state_kept": "Selles seadmes", + "kept_state_waiting": "Ootab allalaadimist", + "kept_error_tooLarge": "Liiga suur hoidmiseks", + "kept_error_overLimit": "Ületab selle seadme piiri", + "kept_error_notAllowed": "Sinu organisatsioon ei luba faile hoida", + "kept_error_download": "Allalaadimine ebaõnnestus", + "keep_offline": "Hoia võrguta", + "unpin": "Ära hoia enam võrguta", + "unpin_label": "Ära hoia faili {name} enam võrguta" + }, "deep_link": { "message_not_found": "See sõnum ei ole enam saadaval.", "thread_not_found": "See vestlus ei ole enam saadaval.", diff --git a/locales/fa/common.json b/locales/fa/common.json index 270c6c3a8..0e1056d21 100644 --- a/locales/fa/common.json +++ b/locales/fa/common.json @@ -5756,6 +5756,61 @@ "toast": "تغییرات آفلاین که اعمال نشدند: {count}. صندوق خروجی نشان می‌دهد کدام‌ها.", "storage_failed": "در این دستگاه جایی برای ایمیل آفلاین نمانده است. فضا را آزاد کنید یا در تنظیمات مقدار کمتری نگه دارید." }, + "offlineStorage": { + "keep_description": "ایمیل‌ها، تقویم، مخاطبان و فایل‌هایی را که انتخاب می‌کنید به‌صورت رمزگذاری‌شده در این مرورگر نگه می‌دارد. در حالت آفلاین می‌توانید ایمیل‌ها را بخوانید، پرچم بزنید و جابه‌جا کنید، و آنچه می‌نویسید در صندوق خروجی منتظر می‌ماند. با خروج از حساب همه پاک می‌شود.", + "window_label": "تا چه مدت قبل نگه داشته شود", + "window_description": "ایمیل‌ها و رویدادهای تقویم قدیمی‌تر از این دستگاه حذف می‌شوند. وقتی اتصال دارید همچنان می‌توانید آن‌ها را باز کنید.", + "window_days": "{days, plural, one {# روز} other {# روز}}", + "window_year": "۱ سال", + "window_everything": "همه چیز", + "attachments_label": "نگه داشتن پیوست‌ها", + "attachments_description": "پیوست‌های پیام‌های نگه‌داشته‌شده و فایل‌هایی که آفلاین نگه می‌دارید، در مجموع تا {total}. قدیمی‌ترین‌ها اول حذف می‌شوند.", + "total_locked": "سازمان شما حداکثر {size} پیوست و فایل را مجاز می‌داند.", + "attachment_cap_label": "بزرگ‌ترین پیوستی که نگه داشته می‌شود", + "usage_mail": "پیام‌ها و نمایه جست‌وجو", + "usage_attachments": "پیوست‌ها", + "usage_calendar": "تقویم", + "usage_contacts": "مخاطبان", + "usage_files": "فایل‌های نگه‌داشته‌شده آفلاین", + "usage_row": "{size} ({count, plural, one {# مورد} other {# مورد}})", + "progress_list": "در حال فهرست‌کردن پیام‌ها", + "progress_bodies": "در حال دانلود پیام‌ها", + "progress_threads": "در حال مرتب‌سازی گفتگوها", + "progress_files": "در حال دانلود فایل‌ها", + "progress_other": "در حال آوردن داده‌ها به این دستگاه", + "progress_count": "{done} از {total}", + "progress_count_open": "تا اینجا {done}", + "progress_left": "حدود {minutes, plural, one {# دقیقه} other {# دقیقه}} مانده", + "clear_label": "پاک‌کردن این حساب", + "clear_description": "هر چه این دستگاه برای این حساب نگه می‌دارد حذف می‌کند و دوباره دانلود می‌کند.", + "clear_button": "پاک‌کردن…", + "clear_confirm_title": "این حساب روی این دستگاه پاک شود؟", + "clear_confirm_message": "هر چه این دستگاه برای این حساب نگه می‌دارد حذف و دوباره دانلود می‌شود. ایمیل‌های شما روی سرور می‌مانند.", + "clear_confirm_unsent": "{count, plural, one {# پیام ارسال‌نشده از بین می‌رود.} other {# پیام ارسال‌نشده از بین می‌روند.}}", + "clear_confirm": "پاک‌کردن", + "persist_refused": "وقتی فضا کم شود، این مرورگر ممکن است ایمیل‌های نگه‌داشته‌شده را حذف کند. نصب برنامه معمولاً جلوی این را می‌گیرد.", + "persist_retry": "دوباره بپرس", + "safari_hint": "Safari داده‌های یک سایت را پس از ۷ روز بدون بازدید حذف می‌کند. Bulwark را به صفحه اصلی یا Dock اضافه کنید تا ایمیل‌هایتان روی این دستگاه بماند.", + "evicted": "مرورگر ایمیل‌های نگه‌داشته‌شده روی این دستگاه را حذف کرد. دوباره دانلود می‌شوند.", + "evicted_lost": "{count, plural, one {# پیام یا تغییر ارسال‌نشده از بین رفت.} other {# پیام یا تغییر ارسال‌نشده از بین رفتند.}}", + "evicted_dismiss": "تأیید", + "storage_full_title": "حافظه دستگاه پر است.", + "storage_full_text": "Bulwark دیگر ایمیلی را اینجا ذخیره نمی‌کند. ایمیل کمتری نگه دارید یا این حساب را پاک کنید تا جا باز شود.", + "open_settings": "باز کردن تنظیمات", + "default_on": "Bulwark ایمیل‌هایتان را روی این دستگاه نگه می‌دارد تا بدون اتصال هم کار کند. می‌توانید این را در تنظیمات تغییر دهید.", + "conflict_calendar": "رویداد تقویم", + "conflict_contacts": "مخاطب", + "kept_files_title": "فایل‌های نگه‌داشته‌شده آفلاین", + "kept_state_kept": "روی این دستگاه", + "kept_state_waiting": "در انتظار دانلود", + "kept_error_tooLarge": "برای نگه‌داشتن بیش از حد بزرگ است", + "kept_error_overLimit": "از حد این دستگاه بیشتر است", + "kept_error_notAllowed": "سازمان شما نگه‌داشتن فایل‌ها را مجاز نمی‌داند", + "kept_error_download": "دانلود نشد", + "keep_offline": "نگه داشتن آفلاین", + "unpin": "دیگر آفلاین نگه داشته نشود", + "unpin_label": "{name} دیگر آفلاین نگه داشته نشود" + }, "deep_link": { "message_not_found": "این پیام دیگر در دسترس نیست.", "thread_not_found": "این گفتگو دیگر در دسترس نیست.", diff --git a/locales/fr/common.json b/locales/fr/common.json index dae94c9c7..f1e6d1484 100644 --- a/locales/fr/common.json +++ b/locales/fr/common.json @@ -5756,6 +5756,61 @@ "toast": "Des modifications faites hors ligne n'ont pas été appliquées : {count}. La boîte d'envoi indique lesquelles.", "storage_failed": "Cet appareil n'a plus de place pour le courrier hors ligne. Libérez de l'espace ou conservez moins dans les paramètres." }, + "offlineStorage": { + "keep_description": "Garde vos e-mails, votre agenda, vos contacts et les fichiers que vous choisissez, chiffrés dans ce navigateur. Hors ligne, vous pouvez lire, signaler et déplacer des e-mails, et ce que vous écrivez attend dans la boîte d'envoi. La déconnexion supprime tout.", + "window_label": "Durée de conservation", + "window_description": "Les e-mails et événements plus anciens quittent cet appareil. Vous pouvez toujours les ouvrir quand vous êtes connecté.", + "window_days": "{days, plural, one {# jour} other {# jours}}", + "window_year": "1 an", + "window_everything": "Tout", + "attachments_label": "Garder les pièces jointes", + "attachments_description": "Pièces jointes des messages gardés et fichiers que vous gardez hors ligne, jusqu'à {total} au total. Les plus anciens partent en premier.", + "total_locked": "Votre organisation autorise au maximum {size} de pièces jointes et de fichiers.", + "attachment_cap_label": "Plus grande pièce jointe à garder", + "usage_mail": "Messages et index de recherche", + "usage_attachments": "Pièces jointes", + "usage_calendar": "Agenda", + "usage_contacts": "Contacts", + "usage_files": "Fichiers gardés hors ligne", + "usage_row": "{size} ({count, plural, one {# élément} other {# éléments}})", + "progress_list": "Liste des messages", + "progress_bodies": "Téléchargement des messages", + "progress_threads": "Tri des conversations", + "progress_files": "Téléchargement des fichiers", + "progress_other": "Transfert des données vers cet appareil", + "progress_count": "{done} sur {total}", + "progress_count_open": "{done} jusqu'ici", + "progress_left": "environ {minutes, plural, one {# minute} other {# minutes}} restantes", + "clear_label": "Vider ce compte", + "clear_description": "Supprime tout ce que cet appareil garde pour ce compte, puis le télécharge de nouveau.", + "clear_button": "Vider…", + "clear_confirm_title": "Vider ce compte sur cet appareil ?", + "clear_confirm_message": "Tout ce que cet appareil garde pour ce compte est supprimé puis téléchargé de nouveau. Vos e-mails sur le serveur restent en place.", + "clear_confirm_unsent": "{count, plural, one {# message non envoyé sera perdu.} other {# messages non envoyés seront perdus.}}", + "clear_confirm": "Vider", + "persist_refused": "Ce navigateur peut supprimer les e-mails gardés quand la place manque. Installer l'application l'évite en général.", + "persist_retry": "Redemander", + "safari_hint": "Safari supprime les données d'un site après 7 jours sans visite. Ajoutez Bulwark à votre écran d'accueil ou au Dock pour garder vos e-mails sur cet appareil.", + "evicted": "Le navigateur a supprimé les e-mails gardés sur cet appareil. Ils sont de nouveau en cours de téléchargement.", + "evicted_lost": "{count, plural, one {# message ou modification non envoyé a été perdu.} other {# messages ou modifications non envoyés ont été perdus.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Le stockage de l'appareil est plein.", + "storage_full_text": "Bulwark n'enregistre plus d'e-mails ici. Gardez moins d'e-mails ou videz ce compte pour libérer de la place.", + "open_settings": "Ouvrir les réglages", + "default_on": "Bulwark garde vos e-mails sur cet appareil pour fonctionner sans connexion. Vous pouvez le modifier dans les réglages.", + "conflict_calendar": "Événement de l'agenda", + "conflict_contacts": "Contact", + "kept_files_title": "Fichiers gardés hors ligne", + "kept_state_kept": "Sur cet appareil", + "kept_state_waiting": "En attente de téléchargement", + "kept_error_tooLarge": "Trop volumineux pour être gardé", + "kept_error_overLimit": "Limite de cet appareil dépassée", + "kept_error_notAllowed": "Votre organisation n'autorise pas de garder des fichiers", + "kept_error_download": "Téléchargement impossible", + "keep_offline": "Garder hors ligne", + "unpin": "Ne plus garder hors ligne", + "unpin_label": "Ne plus garder {name} hors ligne" + }, "deep_link": { "message_not_found": "Ce message n'est plus disponible.", "thread_not_found": "Cette conversation n'est plus disponible.", diff --git a/locales/he/common.json b/locales/he/common.json index 6053b7fc7..9ff456a21 100644 --- a/locales/he/common.json +++ b/locales/he/common.json @@ -5757,6 +5757,61 @@ "toast": "שינויים במצב לא מקוון שלא הוחלו: {count}. דואר יוצא מראה אילו.", "storage_failed": "אין יותר מקום במכשיר הזה לדואר לא מקוון. יש לפנות מקום או לשמור פחות בהגדרות." }, + "offlineStorage": { + "keep_description": "שומר את הדואר, היומן, אנשי הקשר והקבצים שבחרת, מוצפנים בדפדפן הזה. במצב לא מקוון אפשר לקרוא, לסמן ולהעביר דואר, ומה שכותבים ממתין בתיבת הדואר היוצא. התנתקות מוחקת הכול.", + "window_label": "כמה זמן אחורה לשמור", + "window_description": "דואר ואירועי יומן ישנים יותר יוסרו מהמכשיר הזה. אפשר עדיין לפתוח אותם כשיש חיבור.", + "window_days": "{days, plural, one {יום #} two {יומיים} other {# ימים}}", + "window_year": "שנה אחת", + "window_everything": "הכול", + "attachments_label": "שמירת קבצים מצורפים", + "attachments_description": "קבצים מצורפים של הודעות שמורות וקבצים ששומרים במצב לא מקוון, עד {total} בסך הכול. הישנים ביותר מוסרים ראשונים.", + "total_locked": "הארגון שלך מאפשר לכל היותר {size} של קבצים מצורפים וקבצים.", + "attachment_cap_label": "הקובץ המצורף הגדול ביותר לשמירה", + "usage_mail": "הודעות ואינדקס חיפוש", + "usage_attachments": "קבצים מצורפים", + "usage_calendar": "יומן", + "usage_contacts": "אנשי קשר", + "usage_files": "קבצים שמורים במצב לא מקוון", + "usage_row": "{size} ({count, plural, one {פריט #} two {# פריטים} other {# פריטים}})", + "progress_list": "מציג רשימת הודעות", + "progress_bodies": "מוריד הודעות", + "progress_threads": "ממיין שיחות", + "progress_files": "מוריד קבצים", + "progress_other": "מביא נתונים למכשיר הזה", + "progress_count": "{done} מתוך {total}", + "progress_count_open": "עד כה {done}", + "progress_left": "נותרו בערך {minutes, plural, one {דקה #} two {# דקות} other {# דקות}}", + "clear_label": "ניקוי החשבון הזה", + "clear_description": "מוחק את כל מה שהמכשיר הזה שומר עבור החשבון הזה, ואז מוריד אותו מחדש.", + "clear_button": "ניקוי…", + "clear_confirm_title": "לנקות את החשבון הזה במכשיר הזה?", + "clear_confirm_message": "כל מה שהמכשיר הזה שומר עבור החשבון הזה יימחק ויורד מחדש. הדואר שלך בשרת נשאר.", + "clear_confirm_unsent": "{count, plural, one {הודעה אחת שלא נשלחה תאבד.} two {# הודעות שלא נשלחו יאבדו.} other {# הודעות שלא נשלחו יאבדו.}}", + "clear_confirm": "ניקוי", + "persist_refused": "הדפדפן הזה עלול למחוק את הדואר השמור כשנגמר המקום. התקנת האפליקציה בדרך כלל מונעת זאת.", + "persist_retry": "לשאול שוב", + "safari_hint": "Safari מוחק את נתוני האתר אחרי 7 ימים בלי ביקור. הוסיפו את Bulwark למסך הבית או ל-Dock כדי לשמור את הדואר במכשיר הזה.", + "evicted": "הדפדפן מחק את הדואר ששמור במכשיר הזה. הוא יורד מחדש.", + "evicted_lost": "{count, plural, one {הודעה אחת או שינוי אחד שלא נשלחו אבדו.} two {# הודעות או שינויים שלא נשלחו אבדו.} other {# הודעות או שינויים שלא נשלחו אבדו.}}", + "evicted_dismiss": "אישור", + "storage_full_title": "האחסון במכשיר מלא.", + "storage_full_text": "Bulwark הפסיק לשמור כאן דואר. שמרו פחות דואר או נקו את החשבון הזה כדי לפנות מקום.", + "open_settings": "פתיחת הגדרות", + "default_on": "Bulwark שומר את הדואר שלך במכשיר הזה כדי שיעבוד בלי חיבור. אפשר לשנות זאת בהגדרות.", + "conflict_calendar": "אירוע ביומן", + "conflict_contacts": "איש קשר", + "kept_files_title": "קבצים שמורים במצב לא מקוון", + "kept_state_kept": "במכשיר הזה", + "kept_state_waiting": "ממתין להורדה", + "kept_error_tooLarge": "גדול מדי לשמירה", + "kept_error_overLimit": "חורג מהמגבלה של המכשיר הזה", + "kept_error_notAllowed": "הארגון שלך לא מאפשר לשמור קבצים", + "kept_error_download": "לא ניתן היה להוריד", + "keep_offline": "שמירה במצב לא מקוון", + "unpin": "הפסקת שמירה במצב לא מקוון", + "unpin_label": "הפסקת שמירה של {name} במצב לא מקוון" + }, "deep_link": { "message_not_found": "הודעה זו אינה זמינה עוד.", "thread_not_found": "שיחה זו אינה זמינה עוד.", diff --git a/locales/hu/common.json b/locales/hu/common.json index 07cca9946..cee547999 100644 --- a/locales/hu/common.json +++ b/locales/hu/common.json @@ -5756,6 +5756,61 @@ "toast": "Offline végzett, nem alkalmazott módosítások: {count}. A postázandók mappa mutatja, melyek.", "storage_failed": "Ezen az eszközön nincs több hely az offline leveleknek. Szabadítson fel helyet, vagy tartson meg kevesebbet a beállításokban." }, + "offlineStorage": { + "keep_description": "Megtartja a leveleit, a naptárát, a névjegyeit és a kiválasztott fájlokat, titkosítva ebben a böngészőben. Offline olvashat, megjelölhet és áthelyezhet leveleket, a megírt levelek pedig a postázandók között várnak. Kijelentkezéskor minden törlődik.", + "window_label": "Mennyi időre visszamenőleg maradjon meg", + "window_description": "A régebbi levelek és naptáresemények lekerülnek erről az eszközről. Online állapotban továbbra is megnyithatja őket.", + "window_days": "{days, plural, one {# nap} other {# nap}}", + "window_year": "1 év", + "window_everything": "Minden", + "attachments_label": "Mellékletek megtartása", + "attachments_description": "A megtartott levelek mellékletei és az offline megtartott fájlok, összesen legfeljebb {total}. A legrégebbiek törlődnek először.", + "total_locked": "A szervezete legfeljebb {size} mellékletet és fájlt engedélyez.", + "attachment_cap_label": "A megtartott legnagyobb melléklet", + "usage_mail": "Levelek és keresési index", + "usage_attachments": "Mellékletek", + "usage_calendar": "Naptár", + "usage_contacts": "Névjegyek", + "usage_files": "Offline megtartott fájlok", + "usage_row": "{size} ({count, plural, one {# elem} other {# elem}})", + "progress_list": "Levelek listázása", + "progress_bodies": "Levelek letöltése", + "progress_threads": "Beszélgetések rendezése", + "progress_files": "Fájlok letöltése", + "progress_other": "Adatok áthozása erre az eszközre", + "progress_count": "{done} / {total}", + "progress_count_open": "eddig {done}", + "progress_left": "körülbelül {minutes, plural, one {# perc} other {# perc}} van hátra", + "clear_label": "Fiók kiürítése", + "clear_description": "Törli mindazt, amit ez az eszköz ehhez a fiókhoz megtart, majd újra letölti.", + "clear_button": "Kiürítés…", + "clear_confirm_title": "Kiüríti a fiókot ezen az eszközön?", + "clear_confirm_message": "Minden, amit ez az eszköz ehhez a fiókhoz megtart, törlődik és újra letöltődik. A szerveren lévő levelei megmaradnak.", + "clear_confirm_unsent": "{count, plural, one {# el nem küldött levél elvész.} other {# el nem küldött levél elvész.}}", + "clear_confirm": "Kiürítés", + "persist_refused": "Ez a böngésző törölheti a megtartott leveleket, ha fogy a hely. Az alkalmazás telepítése ezt általában megakadályozza.", + "persist_retry": "Újra rákérdez", + "safari_hint": "A Safari 7 nap látogatás nélkül törli egy webhely adatait. Adja hozzá a Bulwarkot a Főképernyőhöz vagy a Dockhoz, hogy a levelei az eszközön maradjanak.", + "evicted": "A böngésző törölte az ezen az eszközön megtartott leveleket. Újra letöltődnek.", + "evicted_lost": "{count, plural, one {# el nem küldött levél vagy módosítás elveszett.} other {# el nem küldött levél vagy módosítás elveszett.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Az eszköz tárhelye megtelt.", + "storage_full_text": "A Bulwark nem ment több levelet ide. Tartson meg kevesebb levelet, vagy ürítse ki ezt a fiókot, hogy legyen hely.", + "open_settings": "Beállítások megnyitása", + "default_on": "A Bulwark ezen az eszközön tartja meg a leveleit, hogy kapcsolat nélkül is működjön. Ezt a Beállításokban módosíthatja.", + "conflict_calendar": "Naptáresemény", + "conflict_contacts": "Névjegy", + "kept_files_title": "Offline megtartott fájlok", + "kept_state_kept": "Ezen az eszközön", + "kept_state_waiting": "Letöltésre vár", + "kept_error_tooLarge": "Túl nagy a megtartáshoz", + "kept_error_overLimit": "Meghaladja az eszköz korlátját", + "kept_error_notAllowed": "A szervezete nem engedi a fájlok megtartását", + "kept_error_download": "Nem sikerült letölteni", + "keep_offline": "Megtartás offline", + "unpin": "Megtartás offline megszüntetése", + "unpin_label": "{name} offline megtartásának megszüntetése" + }, "deep_link": { "message_not_found": "Ez az üzenet már nem érhető el.", "thread_not_found": "Ez a beszélgetés már nem érhető el.", diff --git a/locales/it/common.json b/locales/it/common.json index 398c64b80..a5110bfd8 100644 --- a/locales/it/common.json +++ b/locales/it/common.json @@ -5756,6 +5756,61 @@ "toast": "Modifiche fatte offline non applicate: {count}. La posta in uscita indica quali.", "storage_failed": "Questo dispositivo non ha più spazio per la posta offline. Libera spazio o conservane meno nelle impostazioni." }, + "offlineStorage": { + "keep_description": "Conserva la tua posta, il calendario, i contatti e i file che scegli, cifrati in questo browser. Offline puoi leggere, contrassegnare e spostare la posta, e ciò che scrivi aspetta nella posta in uscita. Uscendo dall'account viene rimosso tutto.", + "window_label": "Da quanto tempo conservare", + "window_description": "La posta e gli eventi più vecchi lasciano questo dispositivo. Puoi comunque aprirli quando sei online.", + "window_days": "{days, plural, one {# giorno} other {# giorni}}", + "window_year": "1 anno", + "window_everything": "Tutto", + "attachments_label": "Conserva gli allegati", + "attachments_description": "Allegati dei messaggi conservati e file che tieni offline, fino a {total} in totale. I più vecchi vengono rimossi per primi.", + "total_locked": "La tua organizzazione consente al massimo {size} di allegati e file.", + "attachment_cap_label": "Allegato più grande da conservare", + "usage_mail": "Messaggi e indice di ricerca", + "usage_attachments": "Allegati", + "usage_calendar": "Calendario", + "usage_contacts": "Contatti", + "usage_files": "File conservati offline", + "usage_row": "{size} ({count, plural, one {# elemento} other {# elementi}})", + "progress_list": "Elenco dei messaggi", + "progress_bodies": "Download dei messaggi", + "progress_threads": "Ordinamento delle conversazioni", + "progress_files": "Download dei file", + "progress_other": "Trasferimento dei dati su questo dispositivo", + "progress_count": "{done} di {total}", + "progress_count_open": "{done} finora", + "progress_left": "mancano circa {minutes, plural, one {# minuto} other {# minuti}}", + "clear_label": "Svuota questo account", + "clear_description": "Elimina tutto ciò che questo dispositivo conserva per questo account, poi lo scarica di nuovo.", + "clear_button": "Svuota…", + "clear_confirm_title": "Svuotare questo account su questo dispositivo?", + "clear_confirm_message": "Tutto ciò che questo dispositivo conserva per questo account viene eliminato e scaricato di nuovo. La tua posta sul server resta dov'è.", + "clear_confirm_unsent": "{count, plural, one {# messaggio non inviato andrà perso.} other {# messaggi non inviati andranno persi.}}", + "clear_confirm": "Svuota", + "persist_refused": "Questo browser può eliminare la posta conservata quando lo spazio scarseggia. Installare l'app di solito lo evita.", + "persist_retry": "Chiedi di nuovo", + "safari_hint": "Safari elimina i dati di un sito dopo 7 giorni senza visite. Aggiungi Bulwark alla schermata Home o al Dock per conservare la tua posta su questo dispositivo.", + "evicted": "Il browser ha eliminato la posta conservata su questo dispositivo. Viene scaricata di nuovo.", + "evicted_lost": "{count, plural, one {# messaggio o modifica non inviati sono andati persi.} other {# messaggi o modifiche non inviati sono andati persi.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Lo spazio del dispositivo è esaurito.", + "storage_full_text": "Bulwark ha smesso di salvare la posta qui. Conserva meno posta o svuota questo account per fare spazio.", + "open_settings": "Apri impostazioni", + "default_on": "Bulwark conserva la tua posta su questo dispositivo, così funziona anche senza connessione. Puoi cambiarlo nelle impostazioni.", + "conflict_calendar": "Evento del calendario", + "conflict_contacts": "Contatto", + "kept_files_title": "File conservati offline", + "kept_state_kept": "Su questo dispositivo", + "kept_state_waiting": "In attesa del download", + "kept_error_tooLarge": "Troppo grande per essere conservato", + "kept_error_overLimit": "Oltre il limite di questo dispositivo", + "kept_error_notAllowed": "La tua organizzazione non consente di conservare i file", + "kept_error_download": "Impossibile scaricare", + "keep_offline": "Conserva offline", + "unpin": "Non conservare più offline", + "unpin_label": "Non conservare più {name} offline" + }, "deep_link": { "message_not_found": "Questo messaggio non è più disponibile.", "thread_not_found": "Questa conversazione non è più disponibile.", diff --git a/locales/ja/common.json b/locales/ja/common.json index 7f5688704..87afe9a32 100644 --- a/locales/ja/common.json +++ b/locales/ja/common.json @@ -5756,6 +5756,61 @@ "toast": "オフライン中の変更で適用されなかったもの: {count} 件。送信トレイで確認できます。", "storage_failed": "このデバイスにはオフラインメール用の空き容量がありません。空き容量を増やすか、設定で保存する量を減らしてください。" }, + "offlineStorage": { + "keep_description": "メール、カレンダー、連絡先、選んだファイルを暗号化してこのブラウザーに保存します。オフラインでもメールを読む、フラグを付ける、移動することができ、書いたメールは送信トレイで待機します。サインアウトするとすべて削除されます。", + "window_label": "保存する期間", + "window_description": "これより古いメールとカレンダーの予定はこのデバイスから削除されます。オンラインのときは引き続き開けます。", + "window_days": "{days, plural, other {#日}}", + "window_year": "1年", + "window_everything": "すべて", + "attachments_label": "添付ファイルを保存", + "attachments_description": "保存したメッセージの添付ファイルと、オフライン用に保存したファイルを合計 {total} まで保存します。古いものから削除されます。", + "total_locked": "組織の設定により、添付ファイルとファイルは最大 {size} までです。", + "attachment_cap_label": "保存する添付ファイルの最大サイズ", + "usage_mail": "メッセージと検索インデックス", + "usage_attachments": "添付ファイル", + "usage_calendar": "カレンダー", + "usage_contacts": "連絡先", + "usage_files": "オフライン用に保存したファイル", + "usage_row": "{size}（{count, plural, other {#件}}）", + "progress_list": "メッセージを一覧表示しています", + "progress_bodies": "メッセージをダウンロードしています", + "progress_threads": "スレッドを並べ替えています", + "progress_files": "ファイルをダウンロードしています", + "progress_other": "データをこのデバイスに取り込んでいます", + "progress_count": "{done} / {total}", + "progress_count_open": "ここまで {done}", + "progress_left": "残り約{minutes, plural, other {#分}}", + "clear_label": "このアカウントを消去", + "clear_description": "このデバイスに保存されているこのアカウントのデータをすべて削除し、あらためてダウンロードします。", + "clear_button": "消去…", + "clear_confirm_title": "このデバイスでこのアカウントを消去しますか？", + "clear_confirm_message": "このデバイスに保存されているこのアカウントのデータをすべて削除し、あらためてダウンロードします。サーバー上のメールはそのまま残ります。", + "clear_confirm_unsent": "{count, plural, other {未送信のメッセージ#件が失われます。}}", + "clear_confirm": "消去", + "persist_refused": "空き容量が少なくなると、このブラウザーは保存したメールを削除することがあります。アプリをインストールすると、たいていは防げます。", + "persist_retry": "もう一度確認", + "safari_hint": "Safari は、7日間アクセスがないサイトのデータを削除します。このデバイスにメールを残すには、Bulwark をホーム画面または Dock に追加してください。", + "evicted": "ブラウザーがこのデバイスに保存していたメールを削除しました。あらためてダウンロードしています。", + "evicted_lost": "{count, plural, other {未送信のメッセージまたは変更#件が失われました。}}", + "evicted_dismiss": "OK", + "storage_full_title": "デバイスの空き容量がありません。", + "storage_full_text": "Bulwark はここへのメールの保存を停止しました。保存するメールを減らすか、このアカウントを消去して空きを作ってください。", + "open_settings": "設定を開く", + "default_on": "Bulwark はメールをこのデバイスに保存するので、接続がなくても使えます。設定で変更できます。", + "conflict_calendar": "カレンダーの予定", + "conflict_contacts": "連絡先", + "kept_files_title": "オフライン用に保存したファイル", + "kept_state_kept": "このデバイスにあります", + "kept_state_waiting": "ダウンロード待ち", + "kept_error_tooLarge": "大きすぎて保存できません", + "kept_error_overLimit": "このデバイスの上限を超えています", + "kept_error_notAllowed": "組織の設定によりファイルを保存できません", + "kept_error_download": "ダウンロードできませんでした", + "keep_offline": "オフライン用に保存", + "unpin": "オフライン保存をやめる", + "unpin_label": "{name} のオフライン保存をやめる" + }, "deep_link": { "message_not_found": "このメッセージは利用できなくなりました。", "thread_not_found": "この会話は利用できなくなりました。", diff --git a/locales/ko/common.json b/locales/ko/common.json index 4c06d6b3f..8a406007c 100644 --- a/locales/ko/common.json +++ b/locales/ko/common.json @@ -5756,6 +5756,61 @@ "toast": "오프라인에서 변경했지만 적용되지 않은 항목: {count}개. 보낼 편지함에서 확인할 수 있습니다.", "storage_failed": "이 기기에 오프라인 메일을 저장할 공간이 없습니다. 공간을 확보하거나 설정에서 보관량을 줄이세요." }, + "offlineStorage": { + "keep_description": "메일, 캘린더, 연락처, 선택한 파일을 이 브라우저에 암호화해 보관합니다. 오프라인에서도 메일을 읽고, 플래그를 지정하고, 이동할 수 있으며, 작성한 메일은 보낼편지함에서 대기합니다. 로그아웃하면 모두 삭제됩니다.", + "window_label": "보관할 기간", + "window_description": "이보다 오래된 메일과 캘린더 일정은 이 기기에서 삭제됩니다. 온라인일 때는 계속 열어볼 수 있습니다.", + "window_days": "{days, plural, other {#일}}", + "window_year": "1년", + "window_everything": "전체", + "attachments_label": "첨부 파일 보관", + "attachments_description": "보관한 메시지의 첨부 파일과 오프라인용으로 보관한 파일을 합쳐 최대 {total}까지 보관합니다. 오래된 것부터 삭제됩니다.", + "total_locked": "조직 설정에 따라 첨부 파일과 파일은 최대 {size}까지만 허용됩니다.", + "attachment_cap_label": "보관할 첨부 파일의 최대 크기", + "usage_mail": "메시지 및 검색 색인", + "usage_attachments": "첨부 파일", + "usage_calendar": "캘린더", + "usage_contacts": "연락처", + "usage_files": "오프라인용으로 보관한 파일", + "usage_row": "{size} ({count, plural, other {#개}})", + "progress_list": "메시지 목록을 만드는 중", + "progress_bodies": "메시지를 다운로드하는 중", + "progress_threads": "대화를 정렬하는 중", + "progress_files": "파일을 다운로드하는 중", + "progress_other": "데이터를 이 기기로 가져오는 중", + "progress_count": "{total} 중 {done}", + "progress_count_open": "지금까지 {done}", + "progress_left": "약 {minutes, plural, other {#분}} 남음", + "clear_label": "이 계정 비우기", + "clear_description": "이 기기에 보관된 이 계정의 데이터를 모두 삭제한 뒤 다시 다운로드합니다.", + "clear_button": "비우기…", + "clear_confirm_title": "이 기기에서 이 계정을 비울까요?", + "clear_confirm_message": "이 기기에 보관된 이 계정의 데이터가 모두 삭제되고 다시 다운로드됩니다. 서버에 있는 메일은 그대로 남습니다.", + "clear_confirm_unsent": "{count, plural, other {보내지 않은 메시지 #개가 사라집니다.}}", + "clear_confirm": "비우기", + "persist_refused": "저장 공간이 부족해지면 이 브라우저가 보관한 메일을 삭제할 수 있습니다. 앱을 설치하면 대개 막을 수 있습니다.", + "persist_retry": "다시 요청", + "safari_hint": "Safari는 7일 동안 방문하지 않은 사이트의 데이터를 삭제합니다. 이 기기에 메일을 계속 보관하려면 Bulwark를 홈 화면이나 Dock에 추가하세요.", + "evicted": "브라우저가 이 기기에 보관한 메일을 삭제했습니다. 다시 다운로드하는 중입니다.", + "evicted_lost": "{count, plural, other {보내지 않은 메시지 또는 변경 사항 #개가 사라졌습니다.}}", + "evicted_dismiss": "확인", + "storage_full_title": "기기 저장 공간이 가득 찼습니다.", + "storage_full_text": "Bulwark가 이곳에 메일 저장을 중단했습니다. 보관하는 메일을 줄이거나 이 계정을 비워 공간을 확보하세요.", + "open_settings": "설정 열기", + "default_on": "Bulwark는 연결이 없어도 쓸 수 있도록 메일을 이 기기에 보관합니다. 설정에서 변경할 수 있습니다.", + "conflict_calendar": "캘린더 일정", + "conflict_contacts": "연락처", + "kept_files_title": "오프라인용으로 보관한 파일", + "kept_state_kept": "이 기기에 있음", + "kept_state_waiting": "다운로드 대기 중", + "kept_error_tooLarge": "너무 커서 보관할 수 없음", + "kept_error_overLimit": "이 기기의 한도를 초과함", + "kept_error_notAllowed": "조직에서 파일 보관을 허용하지 않음", + "kept_error_download": "다운로드하지 못함", + "keep_offline": "오프라인용으로 보관", + "unpin": "오프라인 보관 중지", + "unpin_label": "{name} 오프라인 보관 중지" + }, "deep_link": { "message_not_found": "이 메시지를 더 이상 사용할 수 없습니다.", "thread_not_found": "이 대화를 더 이상 사용할 수 없습니다.", diff --git a/locales/lv/common.json b/locales/lv/common.json index 8ebac9b3b..454eaa1bd 100644 --- a/locales/lv/common.json +++ b/locales/lv/common.json @@ -5756,6 +5756,61 @@ "toast": "Bezsaistē veiktās nepiemērotās izmaiņas: {count}. Izsūtne parāda, kuras.", "storage_failed": "Šajā ierīcē vairs nav vietas bezsaistes pastam. Atbrīvojiet vietu vai iestatījumos glabājiet mazāk." }, + "offlineStorage": { + "keep_description": "Glabā jūsu e-pastu, kalendāru, kontaktpersonas un izvēlētos failus šifrētus šajā pārlūkā. Bezsaistē varat lasīt, atzīmēt un pārvietot vēstules, un tas, ko rakstāt, gaida izsūtnē. Izrakstoties viss tiek noņemts.", + "window_label": "Cik tālu atpakaļ glabāt", + "window_description": "Vecākās vēstules un kalendāra notikumi pazūd no šīs ierīces. Tās joprojām varat atvērt, kad ir savienojums.", + "window_days": "{days, plural, zero {# dienu} one {# diena} other {# dienas}}", + "window_year": "1 gads", + "window_everything": "Viss", + "attachments_label": "Glabāt pielikumus", + "attachments_description": "Glabāto vēstuļu pielikumi un faili, ko glabājat bezsaistē, kopā līdz {total}. Vecākie tiek noņemti pirmie.", + "total_locked": "Jūsu organizācija atļauj ne vairāk kā {size} pielikumu un failu.", + "attachment_cap_label": "Lielākais glabājamais pielikums", + "usage_mail": "Vēstules un meklēšanas indekss", + "usage_attachments": "Pielikumi", + "usage_calendar": "Kalendārs", + "usage_contacts": "Kontaktpersonas", + "usage_files": "Bezsaistē glabātie faili", + "usage_row": "{size} ({count, plural, zero {# vienumu} one {# vienums} other {# vienumi}})", + "progress_list": "Vēstuļu saraksta veidošana", + "progress_bodies": "Vēstuļu lejupielāde", + "progress_threads": "Sarunu kārtošana", + "progress_files": "Failu lejupielāde", + "progress_other": "Datu pārnešana uz šo ierīci", + "progress_count": "{done} no {total}", + "progress_count_open": "līdz šim {done}", + "progress_left": "atlikušas apmēram {minutes, plural, zero {# minūšu} one {# minūte} other {# minūtes}}", + "clear_label": "Notīrīt šo kontu", + "clear_description": "Izdzēš visu, ko šī ierīce glabā šim kontam, un lejupielādē to no jauna.", + "clear_button": "Notīrīt…", + "clear_confirm_title": "Vai notīrīt šo kontu šajā ierīcē?", + "clear_confirm_message": "Viss, ko šī ierīce glabā šim kontam, tiek izdzēsts un lejupielādēts no jauna. Jūsu e-pasts serverī paliek.", + "clear_confirm_unsent": "{count, plural, zero {# neizsūtītu vēstuļu tiks zaudēts.} one {Tiks zaudēta # neizsūtīta vēstule.} other {Tiks zaudētas # neizsūtītas vēstules.}}", + "clear_confirm": "Notīrīt", + "persist_refused": "Šis pārlūks var izdzēst glabāto e-pastu, kad pietrūkst vietas. Lietotnes instalēšana to parasti novērš.", + "persist_retry": "Pajautāt vēlreiz", + "safari_hint": "Safari izdzēš vietnes datus pēc 7 dienām bez apmeklējuma. Pievienojiet Bulwark sākuma ekrānam vai Dock, lai e-pasts paliktu šajā ierīcē.", + "evicted": "Pārlūks izdzēsa šajā ierīcē glabāto e-pastu. Tas tiek lejupielādēts no jauna.", + "evicted_lost": "{count, plural, zero {Tika zaudētas # neizsūtītu vēstuļu vai izmaiņu.} one {Tika zaudēta # neizsūtīta vēstule vai izmaiņa.} other {Tika zaudētas # neizsūtītas vēstules vai izmaiņas.}}", + "evicted_dismiss": "Labi", + "storage_full_title": "Ierīces krātuve ir pilna.", + "storage_full_text": "Bulwark vairs šeit nesaglabā e-pastu. Glabājiet mazāk e-pasta vai notīriet šo kontu, lai atbrīvotu vietu.", + "open_settings": "Atvērt iestatījumus", + "default_on": "Bulwark glabā jūsu e-pastu šajā ierīcē, lai tas darbotos bez savienojuma. To varat mainīt iestatījumos.", + "conflict_calendar": "Kalendāra notikums", + "conflict_contacts": "Kontaktpersona", + "kept_files_title": "Bezsaistē glabātie faili", + "kept_state_kept": "Šajā ierīcē", + "kept_state_waiting": "Gaida lejupielādi", + "kept_error_tooLarge": "Pārāk liels, lai glabātu", + "kept_error_overLimit": "Pārsniedz šīs ierīces ierobežojumu", + "kept_error_notAllowed": "Jūsu organizācija neatļauj glabāt failus", + "kept_error_download": "Nevarēja lejupielādēt", + "keep_offline": "Glabāt bezsaistē", + "unpin": "Pārtraukt glabāt bezsaistē", + "unpin_label": "Pārtraukt glabāt {name} bezsaistē" + }, "deep_link": { "message_not_found": "Šī ziņa vairs nav pieejama.", "thread_not_found": "Šī sarakste vairs nav pieejama.", diff --git a/locales/mn/common.json b/locales/mn/common.json index 43edeb367..d7bfaae1f 100644 --- a/locales/mn/common.json +++ b/locales/mn/common.json @@ -5756,6 +5756,61 @@ "toast": "Офлайн хийсэн, хэрэгжээгүй өөрчлөлтүүд: {count}. Аль нь болохыг Илгээх хайрцгаас харна уу.", "storage_failed": "Энэ төхөөрөмжид офлайн захидалд зай үлдсэнгүй. Зай чөлөөлөх эсвэл тохиргооноос цөөнийг хадгална уу." }, + "offlineStorage": { + "keep_description": "Таны имэйл, хуанли, харилцагчид болон сонгосон файлуудыг энэ хөтөч дээр шифрлэн хадгална. Офлайн үед имэйл уншиж, тэмдэглэж, зөөж болох ба бичсэн зүйл тань гарах хайрцагт хүлээнэ. Гарахад бүгд устна.", + "window_label": "Хэр удаан хугацаагаар хадгалах вэ", + "window_description": "Илүү хуучин имэйл болон хуанлийн үйл явдлууд энэ төхөөрөмжөөс устна. Холболттой үед та тэдгээрийг нээж болно.", + "window_days": "{days, plural, one {# өдөр} other {# өдөр}}", + "window_year": "1 жил", + "window_everything": "Бүгд", + "attachments_label": "Хавсралтуудыг хадгалах", + "attachments_description": "Хадгалсан мессежүүдийн хавсралт болон офлайн хадгалсан файлууд, нийт {total} хүртэл. Хамгийн хуучин нь эхэлж устна.", + "total_locked": "Таны байгууллага хавсралт болон файлыг нийтдээ {size} хүртэл зөвшөөрдөг.", + "attachment_cap_label": "Хадгалах хамгийн том хавсралт", + "usage_mail": "Мессеж ба хайлтын индекс", + "usage_attachments": "Хавсралтууд", + "usage_calendar": "Хуанли", + "usage_contacts": "Харилцагчид", + "usage_files": "Офлайн хадгалсан файлууд", + "usage_row": "{size} ({count, plural, one {# зүйл} other {# зүйл}})", + "progress_list": "Мессежүүдийг жагсааж байна", + "progress_bodies": "Мессежүүдийг татаж байна", + "progress_threads": "Харилцан яриаг эрэмбэлж байна", + "progress_files": "Файлуудыг татаж байна", + "progress_other": "Өгөгдлийг энэ төхөөрөмж рүү авчирч байна", + "progress_count": "{total}-аас {done}", + "progress_count_open": "одоогоор {done}", + "progress_left": "ойролцоогоор {minutes, plural, one {# минут} other {# минут}} үлдсэн", + "clear_label": "Энэ бүртгэлийг цэвэрлэх", + "clear_description": "Энэ төхөөрөмж уг бүртгэлд зориулж хадгалсан бүхнийг устгаад дахин татна.", + "clear_button": "Цэвэрлэх…", + "clear_confirm_title": "Энэ бүртгэлийг энэ төхөөрөмж дээр цэвэрлэх үү?", + "clear_confirm_message": "Энэ төхөөрөмж уг бүртгэлд зориулж хадгалсан бүхэн устаж, дахин татагдана. Серверийн имэйл тань хэвээр үлдэнэ.", + "clear_confirm_unsent": "{count, plural, one {# илгээгээгүй мессеж алдагдана.} other {# илгээгээгүй мессеж алдагдана.}}", + "clear_confirm": "Цэвэрлэх", + "persist_refused": "Зай дутвал энэ хөтөч хадгалсан имэйлийг устгаж болно. Аппыг суулгавал ихэвчлэн ийм зүйл болдоггүй.", + "persist_retry": "Дахин асуух", + "safari_hint": "Safari сайтад 7 хоног зочлоогүй бол түүний өгөгдлийг устгадаг. Имэйлээ энэ төхөөрөмж дээр хадгалахын тулд Bulwark-ыг Үндсэн дэлгэц эсвэл Dock-д нэмнэ үү.", + "evicted": "Хөтөч энэ төхөөрөмж дээр хадгалсан имэйлийг устгасан. Дахин татаж байна.", + "evicted_lost": "{count, plural, one {# илгээгээгүй мессеж эсвэл өөрчлөлт алдагдсан.} other {# илгээгээгүй мессеж эсвэл өөрчлөлт алдагдсан.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Төхөөрөмжийн сав дүүрсэн.", + "storage_full_text": "Bulwark энд имэйл хадгалахаа больсон. Бага имэйл хадгалах эсвэл зай гаргахын тулд энэ бүртгэлийг цэвэрлэнэ үү.", + "open_settings": "Тохиргоо нээх", + "default_on": "Bulwark таны имэйлийг энэ төхөөрөмж дээр хадгалдаг тул холболтгүйгээр ажиллана. Үүнийг Тохиргоонд өөрчилж болно.", + "conflict_calendar": "Хуанлийн үйл явдал", + "conflict_contacts": "Харилцагч", + "kept_files_title": "Офлайн хадгалсан файлууд", + "kept_state_kept": "Энэ төхөөрөмж дээр", + "kept_state_waiting": "Татагдахыг хүлээж байна", + "kept_error_tooLarge": "Хадгалахад хэт том", + "kept_error_overLimit": "Энэ төхөөрөмжийн хязгаараас хэтэрсэн", + "kept_error_notAllowed": "Таны байгууллага файл хадгалахыг зөвшөөрдөггүй", + "kept_error_download": "Татаж чадсангүй", + "keep_offline": "Офлайн хадгалах", + "unpin": "Офлайн хадгалахаа болих", + "unpin_label": "{name}-г офлайн хадгалахаа болих" + }, "deep_link": { "message_not_found": "Энэ зурвас дахин ашиглах боломжгүй болсон.", "thread_not_found": "Энэ харилцан яриа дахин ашиглах боломжгүй болсон.", diff --git a/locales/nb/common.json b/locales/nb/common.json index 267f73a56..1f73582b6 100644 --- a/locales/nb/common.json +++ b/locales/nb/common.json @@ -5756,6 +5756,61 @@ "toast": "Endringer gjort uten nett som ikke ble utført: {count}. Utboksen viser hvilke.", "storage_failed": "Denne enheten har ikke mer plass til e-post uten nett. Frigjør plass, eller behold mindre i innstillingene." }, + "offlineStorage": { + "keep_description": "Beholder e-posten, kalenderen, kontaktene og filene du velger, kryptert i denne nettleseren. Frakoblet kan du lese, flagge og flytte e-post, og det du skriver, venter i utboksen. Når du logger av, fjernes alt.", + "window_label": "Hvor langt tilbake som beholdes", + "window_description": "Eldre e-post og kalenderhendelser forlater denne enheten. Du kan fortsatt åpne dem når du er tilkoblet.", + "window_days": "{days, plural, one {# dag} other {# dager}}", + "window_year": "1 år", + "window_everything": "Alt", + "attachments_label": "Behold vedlegg", + "attachments_description": "Vedlegg fra beholdte meldinger og filene du beholder frakoblet, opptil {total} til sammen. De eldste fjernes først.", + "total_locked": "Organisasjonen din tillater høyst {size} med vedlegg og filer.", + "attachment_cap_label": "Største vedlegg som beholdes", + "usage_mail": "Meldinger og søkeindeks", + "usage_attachments": "Vedlegg", + "usage_calendar": "Kalender", + "usage_contacts": "Kontakter", + "usage_files": "Filer beholdt frakoblet", + "usage_row": "{size} ({count, plural, one {# element} other {# elementer}})", + "progress_list": "Lister opp meldinger", + "progress_bodies": "Laster ned meldinger", + "progress_threads": "Sorterer samtaler", + "progress_files": "Laster ned filer", + "progress_other": "Henter data til denne enheten", + "progress_count": "{done} av {total}", + "progress_count_open": "{done} så langt", + "progress_left": "omtrent {minutes, plural, one {# minutt} other {# minutter}} igjen", + "clear_label": "Tøm denne kontoen", + "clear_description": "Sletter alt denne enheten beholder for denne kontoen, og laster det ned på nytt.", + "clear_button": "Tøm…", + "clear_confirm_title": "Tømme denne kontoen på denne enheten?", + "clear_confirm_message": "Alt denne enheten beholder for denne kontoen, slettes og lastes ned på nytt. E-posten din på serveren blir værende.", + "clear_confirm_unsent": "{count, plural, one {# usendt melding går tapt.} other {# usendte meldinger går tapt.}}", + "clear_confirm": "Tøm", + "persist_refused": "Denne nettleseren kan slette den beholdte e-posten når plassen blir knapp. Å installere appen hjelper vanligvis.", + "persist_retry": "Spør igjen", + "safari_hint": "Safari sletter data fra et nettsted etter 7 dager uten besøk. Legg Bulwark til på Hjem-skjermen eller i Dock for å beholde e-posten på denne enheten.", + "evicted": "Nettleseren slettet e-posten som var beholdt på denne enheten. Den lastes ned på nytt.", + "evicted_lost": "{count, plural, one {# usendt melding eller endring gikk tapt.} other {# usendte meldinger eller endringer gikk tapt.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Lagringsplassen på enheten er full.", + "storage_full_text": "Bulwark har sluttet å lagre e-post her. Behold mindre e-post, eller tøm denne kontoen for å få plass.", + "open_settings": "Åpne innstillinger", + "default_on": "Bulwark beholder e-posten din på denne enheten, så den fungerer uten tilkobling. Du kan endre dette i Innstillinger.", + "conflict_calendar": "Kalenderhendelse", + "conflict_contacts": "Kontakt", + "kept_files_title": "Filer beholdt frakoblet", + "kept_state_kept": "På denne enheten", + "kept_state_waiting": "Venter på nedlasting", + "kept_error_tooLarge": "For stor til å beholdes", + "kept_error_overLimit": "Over grensen for denne enheten", + "kept_error_notAllowed": "Organisasjonen din tillater ikke at filer beholdes", + "kept_error_download": "Kunne ikke lastes ned", + "keep_offline": "Behold frakoblet", + "unpin": "Slutt å beholde frakoblet", + "unpin_label": "Slutt å beholde {name} frakoblet" + }, "deep_link": { "message_not_found": "Denne meldingen er ikke lenger tilgjengelig.", "thread_not_found": "Denne samtalen er ikke lenger tilgjengelig.", diff --git a/locales/nl/common.json b/locales/nl/common.json index 1cf1cabbb..b454337fd 100644 --- a/locales/nl/common.json +++ b/locales/nl/common.json @@ -5756,6 +5756,61 @@ "toast": "Offline gemaakte wijzigingen niet doorgevoerd: {count}. Het Postvak UIT laat zien welke.", "storage_failed": "Dit apparaat heeft geen ruimte meer voor offline mail. Maak ruimte vrij of bewaar minder via Instellingen." }, + "offlineStorage": { + "keep_description": "Bewaart je e-mail, agenda, contacten en gekozen bestanden versleuteld in deze browser. Offline kun je e-mail lezen, markeren en verplaatsen, en wat je schrijft wacht in Postvak UIT. Afmelden verwijdert alles.", + "window_label": "Hoe ver terug bewaren", + "window_description": "Oudere e-mail en agenda-items verdwijnen van dit apparaat. Je kunt ze nog openen als je online bent.", + "window_days": "{days, plural, one {# dag} other {# dagen}}", + "window_year": "1 jaar", + "window_everything": "Alles", + "attachments_label": "Bijlagen bewaren", + "attachments_description": "Bijlagen van bewaarde berichten en de bestanden die je offline bewaart, samen maximaal {total}. De oudste gaan eerst weg.", + "total_locked": "Je organisatie staat maximaal {size} aan bijlagen en bestanden toe.", + "attachment_cap_label": "Grootste bijlage om te bewaren", + "usage_mail": "Berichten en zoekindex", + "usage_attachments": "Bijlagen", + "usage_calendar": "Agenda", + "usage_contacts": "Contacten", + "usage_files": "Offline bewaarde bestanden", + "usage_row": "{size} ({count, plural, one {# item} other {# items}})", + "progress_list": "Berichten worden opgesomd", + "progress_bodies": "Berichten worden gedownload", + "progress_threads": "Gesprekken worden gesorteerd", + "progress_files": "Bestanden worden gedownload", + "progress_other": "Gegevens worden naar dit apparaat gehaald", + "progress_count": "{done} van {total}", + "progress_count_open": "{done} tot nu toe", + "progress_left": "nog ongeveer {minutes, plural, one {# minuut} other {# minuten}}", + "clear_label": "Dit account wissen", + "clear_description": "Verwijdert alles wat dit apparaat voor dit account bewaart en downloadt het daarna opnieuw.", + "clear_button": "Wissen…", + "clear_confirm_title": "Dit account op dit apparaat wissen?", + "clear_confirm_message": "Alles wat dit apparaat voor dit account bewaart, wordt verwijderd en opnieuw gedownload. Je e-mail op de server blijft staan.", + "clear_confirm_unsent": "{count, plural, one {# niet-verzonden bericht gaat verloren.} other {# niet-verzonden berichten gaan verloren.}}", + "clear_confirm": "Wissen", + "persist_refused": "Deze browser kan de bewaarde e-mail verwijderen als de ruimte opraakt. De app installeren voorkomt dat meestal.", + "persist_retry": "Opnieuw vragen", + "safari_hint": "Safari verwijdert de gegevens van een site na 7 dagen zonder bezoek. Zet Bulwark op je beginscherm of in het Dock om je e-mail op dit apparaat te houden.", + "evicted": "De browser heeft de e-mail verwijderd die op dit apparaat was bewaard. Ze wordt opnieuw gedownload.", + "evicted_lost": "{count, plural, one {# niet-verzonden bericht of wijziging is verloren gegaan.} other {# niet-verzonden berichten of wijzigingen zijn verloren gegaan.}}", + "evicted_dismiss": "OK", + "storage_full_title": "De opslag van het apparaat is vol.", + "storage_full_text": "Bulwark slaat hier geen e-mail meer op. Bewaar minder e-mail of wis dit account om ruimte te maken.", + "open_settings": "Instellingen openen", + "default_on": "Bulwark bewaart je e-mail op dit apparaat, zodat het ook zonder verbinding werkt. Je kunt dit wijzigen in de instellingen.", + "conflict_calendar": "Agenda-item", + "conflict_contacts": "Contact", + "kept_files_title": "Offline bewaarde bestanden", + "kept_state_kept": "Op dit apparaat", + "kept_state_waiting": "Wacht op download", + "kept_error_tooLarge": "Te groot om te bewaren", + "kept_error_overLimit": "Boven de limiet voor dit apparaat", + "kept_error_notAllowed": "Je organisatie staat het bewaren van bestanden niet toe", + "kept_error_download": "Kon niet worden gedownload", + "keep_offline": "Offline bewaren", + "unpin": "Niet meer offline bewaren", + "unpin_label": "{name} niet meer offline bewaren" + }, "deep_link": { "message_not_found": "Dit bericht is niet meer beschikbaar.", "thread_not_found": "Dit gesprek is niet meer beschikbaar.", diff --git a/locales/pl/common.json b/locales/pl/common.json index 7067bbaaa..34a22cd03 100644 --- a/locales/pl/common.json +++ b/locales/pl/common.json @@ -5756,6 +5756,61 @@ "toast": "Niezastosowane zmiany wprowadzone offline: {count}. Skrzynka nadawcza pokazuje które.", "storage_failed": "Na tym urządzeniu nie ma już miejsca na pocztę offline. Zwolnij miejsce lub zachowuj mniej w ustawieniach." }, + "offlineStorage": { + "keep_description": "Przechowuje Twoją pocztę, kalendarz, kontakty i wybrane pliki zaszyfrowane w tej przeglądarce. Offline możesz czytać, oznaczać i przenosić wiadomości, a to, co napiszesz, czeka w skrzynce nadawczej. Wylogowanie usuwa wszystko.", + "window_label": "Jak daleko wstecz przechowywać", + "window_description": "Starsza poczta i wydarzenia z kalendarza znikają z tego urządzenia. Nadal możesz je otworzyć, gdy masz połączenie.", + "window_days": "{days, plural, one {# dzień} few {# dni} many {# dni} other {# dnia}}", + "window_year": "1 rok", + "window_everything": "Wszystko", + "attachments_label": "Przechowuj załączniki", + "attachments_description": "Załączniki przechowywanych wiadomości i pliki przechowywane offline, razem do {total}. Najstarsze są usuwane najpierw.", + "total_locked": "Twoja organizacja zezwala na najwyżej {size} załączników i plików.", + "attachment_cap_label": "Największy przechowywany załącznik", + "usage_mail": "Wiadomości i indeks wyszukiwania", + "usage_attachments": "Załączniki", + "usage_calendar": "Kalendarz", + "usage_contacts": "Kontakty", + "usage_files": "Pliki przechowywane offline", + "usage_row": "{size} ({count, plural, one {# element} few {# elementy} many {# elementów} other {# elementu}})", + "progress_list": "Wyszukiwanie wiadomości", + "progress_bodies": "Pobieranie wiadomości", + "progress_threads": "Sortowanie konwersacji", + "progress_files": "Pobieranie plików", + "progress_other": "Przenoszenie danych na to urządzenie", + "progress_count": "{done} z {total}", + "progress_count_open": "dotąd {done}", + "progress_left": "zostało około {minutes, plural, one {# minuty} few {# minut} many {# minut} other {# minuty}}", + "clear_label": "Wyczyść to konto", + "clear_description": "Usuwa wszystko, co to urządzenie przechowuje dla tego konta, a potem pobiera to ponownie.", + "clear_button": "Wyczyść…", + "clear_confirm_title": "Wyczyścić to konto na tym urządzeniu?", + "clear_confirm_message": "Wszystko, co to urządzenie przechowuje dla tego konta, zostanie usunięte i pobrane ponownie. Twoja poczta na serwerze zostaje.", + "clear_confirm_unsent": "{count, plural, one {# niewysłana wiadomość zostanie utracona.} few {# niewysłane wiadomości zostaną utracone.} many {# niewysłanych wiadomości zostanie utraconych.} other {# niewysłanej wiadomości zostanie utraconej.}}", + "clear_confirm": "Wyczyść", + "persist_refused": "Ta przeglądarka może usunąć przechowywaną pocztę, gdy zabraknie miejsca. Zainstalowanie aplikacji zwykle temu zapobiega.", + "persist_retry": "Zapytaj ponownie", + "safari_hint": "Safari usuwa dane witryny po 7 dniach bez odwiedzin. Dodaj Bulwark do ekranu początkowego lub do Docka, aby zachować pocztę na tym urządzeniu.", + "evicted": "Przeglądarka usunęła pocztę przechowywaną na tym urządzeniu. Jest pobierana ponownie.", + "evicted_lost": "{count, plural, one {Utracono # niewysłaną wiadomość lub zmianę.} few {Utracono # niewysłane wiadomości lub zmiany.} many {Utracono # niewysłanych wiadomości lub zmian.} other {Utracono # niewysłanej wiadomości lub zmiany.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Pamięć urządzenia jest pełna.", + "storage_full_text": "Bulwark przestał tu zapisywać pocztę. Przechowuj mniej poczty albo wyczyść to konto, aby zwolnić miejsce.", + "open_settings": "Otwórz ustawienia", + "default_on": "Bulwark przechowuje Twoją pocztę na tym urządzeniu, żeby działała bez połączenia. Możesz to zmienić w Ustawieniach.", + "conflict_calendar": "Wydarzenie w kalendarzu", + "conflict_contacts": "Kontakt", + "kept_files_title": "Pliki przechowywane offline", + "kept_state_kept": "Na tym urządzeniu", + "kept_state_waiting": "Czeka na pobranie", + "kept_error_tooLarge": "Za duży, aby go przechowywać", + "kept_error_overLimit": "Przekracza limit tego urządzenia", + "kept_error_notAllowed": "Twoja organizacja nie zezwala na przechowywanie plików", + "kept_error_download": "Nie udało się pobrać", + "keep_offline": "Przechowuj offline", + "unpin": "Nie przechowuj już offline", + "unpin_label": "Nie przechowuj już {name} offline" + }, "deep_link": { "message_not_found": "Ta wiadomość nie jest już dostępna.", "thread_not_found": "Ta rozmowa nie jest już dostępna.", diff --git a/locales/pt/common.json b/locales/pt/common.json index 4bce29dd5..0e5413f17 100644 --- a/locales/pt/common.json +++ b/locales/pt/common.json @@ -5756,6 +5756,61 @@ "toast": "Alterações feitas offline não aplicadas: {count}. A caixa de saída mostra quais.", "storage_failed": "Este dispositivo não tem espaço para o correio offline. Liberte espaço ou guarde menos nas definições." }, + "offlineStorage": { + "keep_description": "Mantém o seu correio, calendário, contactos e os ficheiros que escolher, cifrados neste navegador. Offline pode ler, sinalizar e mover e-mails, e o que escrever espera na caixa de saída. Terminar a sessão remove tudo.", + "window_label": "Quanto tempo atrás manter", + "window_description": "Os e-mails e eventos mais antigos saem deste dispositivo. Pode continuar a abri-los quando tiver ligação.", + "window_days": "{days, plural, one {# dia} other {# dias}}", + "window_year": "1 ano", + "window_everything": "Tudo", + "attachments_label": "Manter anexos", + "attachments_description": "Anexos das mensagens mantidas e ficheiros que mantém offline, até {total} no total. Os mais antigos saem primeiro.", + "total_locked": "A sua organização permite no máximo {size} de anexos e ficheiros.", + "attachment_cap_label": "Maior anexo a manter", + "usage_mail": "Mensagens e índice de pesquisa", + "usage_attachments": "Anexos", + "usage_calendar": "Calendário", + "usage_contacts": "Contactos", + "usage_files": "Ficheiros mantidos offline", + "usage_row": "{size} ({count, plural, one {# item} other {# itens}})", + "progress_list": "A listar mensagens", + "progress_bodies": "A transferir mensagens", + "progress_threads": "A ordenar conversas", + "progress_files": "A transferir ficheiros", + "progress_other": "A trazer dados para este dispositivo", + "progress_count": "{done} de {total}", + "progress_count_open": "{done} até agora", + "progress_left": "faltam cerca de {minutes, plural, one {# minuto} other {# minutos}}", + "clear_label": "Limpar esta conta", + "clear_description": "Elimina tudo o que este dispositivo mantém para esta conta e volta a transferi-lo.", + "clear_button": "Limpar…", + "clear_confirm_title": "Limpar esta conta neste dispositivo?", + "clear_confirm_message": "Tudo o que este dispositivo mantém para esta conta é eliminado e transferido novamente. O seu correio no servidor mantém-se.", + "clear_confirm_unsent": "{count, plural, one {# mensagem por enviar será perdida.} other {# mensagens por enviar serão perdidas.}}", + "clear_confirm": "Limpar", + "persist_refused": "Este navegador pode eliminar o correio mantido quando o espaço escasseia. Instalar a aplicação costuma evitá-lo.", + "persist_retry": "Perguntar novamente", + "safari_hint": "O Safari elimina os dados de um site após 7 dias sem visitas. Adicione o Bulwark ao Ecrã Principal ou ao Dock para manter o seu correio neste dispositivo.", + "evicted": "O navegador eliminou o correio mantido neste dispositivo. Está a ser transferido novamente.", + "evicted_lost": "{count, plural, one {# mensagem ou alteração por enviar foi perdida.} other {# mensagens ou alterações por enviar foram perdidas.}}", + "evicted_dismiss": "OK", + "storage_full_title": "O armazenamento do dispositivo está cheio.", + "storage_full_text": "O Bulwark deixou de guardar correio aqui. Mantenha menos correio ou limpe esta conta para libertar espaço.", + "open_settings": "Abrir definições", + "default_on": "O Bulwark mantém o seu correio neste dispositivo, para funcionar sem ligação. Pode alterar isto nas Definições.", + "conflict_calendar": "Evento do calendário", + "conflict_contacts": "Contacto", + "kept_files_title": "Ficheiros mantidos offline", + "kept_state_kept": "Neste dispositivo", + "kept_state_waiting": "A aguardar transferência", + "kept_error_tooLarge": "Demasiado grande para manter", + "kept_error_overLimit": "Acima do limite deste dispositivo", + "kept_error_notAllowed": "A sua organização não permite manter ficheiros", + "kept_error_download": "Não foi possível transferir", + "keep_offline": "Manter offline", + "unpin": "Deixar de manter offline", + "unpin_label": "Deixar de manter {name} offline" + }, "deep_link": { "message_not_found": "Esta mensagem não está mais disponível.", "thread_not_found": "Esta conversa não está mais disponível.", diff --git a/locales/ro/common.json b/locales/ro/common.json index 17abb3f3a..413843d3a 100644 --- a/locales/ro/common.json +++ b/locales/ro/common.json @@ -5756,6 +5756,61 @@ "toast": "Modificări făcute offline care nu au fost aplicate: {count}. Căsuța de trimitere arată care.", "storage_failed": "Acest dispozitiv nu mai are loc pentru e-mailul offline. Eliberați spațiu sau păstrați mai puțin din setări." }, + "offlineStorage": { + "keep_description": "Păstrează e-mailurile, calendarul, contactele și fișierele alese de dvs., criptate în acest browser. Offline puteți citi, marca și muta e-mailuri, iar ce scrieți așteaptă în Mesaje de trimis. La deconectare se șterge totul.", + "window_label": "Cât de departe în urmă se păstrează", + "window_description": "E-mailurile și evenimentele mai vechi dispar de pe acest dispozitiv. Le puteți deschide în continuare când sunteți online.", + "window_days": "{days, plural, one {# zi} few {# zile} other {# de zile}}", + "window_year": "1 an", + "window_everything": "Tot", + "attachments_label": "Păstrează atașamentele", + "attachments_description": "Atașamentele mesajelor păstrate și fișierele păstrate offline, în total până la {total}. Cele mai vechi sunt șterse primele.", + "total_locked": "Organizația dvs. permite cel mult {size} de atașamente și fișiere.", + "attachment_cap_label": "Cel mai mare atașament păstrat", + "usage_mail": "Mesaje și index de căutare", + "usage_attachments": "Atașamente", + "usage_calendar": "Calendar", + "usage_contacts": "Contacte", + "usage_files": "Fișiere păstrate offline", + "usage_row": "{size} ({count, plural, one {# element} few {# elemente} other {# de elemente}})", + "progress_list": "Se listează mesajele", + "progress_bodies": "Se descarcă mesajele", + "progress_threads": "Se sortează conversațiile", + "progress_files": "Se descarcă fișierele", + "progress_other": "Se aduc date pe acest dispozitiv", + "progress_count": "{done} din {total}", + "progress_count_open": "{done} până acum", + "progress_left": "mai durează aproximativ {minutes, plural, one {# minut} few {# minute} other {# de minute}}", + "clear_label": "Golește acest cont", + "clear_description": "Șterge tot ce păstrează acest dispozitiv pentru acest cont, apoi descarcă din nou.", + "clear_button": "Golește…", + "clear_confirm_title": "Goliți acest cont pe acest dispozitiv?", + "clear_confirm_message": "Tot ce păstrează acest dispozitiv pentru acest cont este șters și descărcat din nou. E-mailurile dvs. de pe server rămân.", + "clear_confirm_unsent": "{count, plural, one {# mesaj netrimis se pierde.} few {# mesaje netrimise se pierd.} other {# de mesaje netrimise se pierd.}}", + "clear_confirm": "Golește", + "persist_refused": "Acest browser poate șterge e-mailurile păstrate când se termină spațiul. Instalarea aplicației de obicei previne asta.", + "persist_retry": "Întreabă din nou", + "safari_hint": "Safari șterge datele unui site după 7 zile fără vizite. Adăugați Bulwark pe ecranul principal sau în Dock ca să păstrați e-mailurile pe acest dispozitiv.", + "evicted": "Browserul a șters e-mailurile păstrate pe acest dispozitiv. Se descarcă din nou.", + "evicted_lost": "{count, plural, one {# mesaj sau modificare netrimis s-a pierdut.} few {# mesaje sau modificări netrimise s-au pierdut.} other {# de mesaje sau modificări netrimise s-au pierdut.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Spațiul dispozitivului este plin.", + "storage_full_text": "Bulwark nu mai salvează e-mailuri aici. Păstrați mai puține e-mailuri sau goliți acest cont pentru a face loc.", + "open_settings": "Deschide setările", + "default_on": "Bulwark păstrează e-mailurile pe acest dispozitiv, ca să funcționeze fără conexiune. Puteți schimba asta în Setări.", + "conflict_calendar": "Eveniment din calendar", + "conflict_contacts": "Contact", + "kept_files_title": "Fișiere păstrate offline", + "kept_state_kept": "Pe acest dispozitiv", + "kept_state_waiting": "Așteaptă descărcarea", + "kept_error_tooLarge": "Prea mare pentru a fi păstrat", + "kept_error_overLimit": "Peste limita acestui dispozitiv", + "kept_error_notAllowed": "Organizația dvs. nu permite păstrarea fișierelor", + "kept_error_download": "Nu a putut fi descărcat", + "keep_offline": "Păstrează offline", + "unpin": "Nu mai păstra offline", + "unpin_label": "Nu mai păstra {name} offline" + }, "deep_link": { "message_not_found": "Acest mesaj nu mai este disponibil.", "thread_not_found": "Această conversație nu mai este disponibilă.", diff --git a/locales/ru/common.json b/locales/ru/common.json index 9d50c9b45..dd3538569 100644 --- a/locales/ru/common.json +++ b/locales/ru/common.json @@ -5756,6 +5756,61 @@ "toast": "Изменения, внесённые офлайн и не применённые: {count}. Какие именно, видно в исходящих.", "storage_failed": "На этом устройстве не осталось места для офлайн-почты. Освободите место или храните меньше в настройках." }, + "offlineStorage": { + "keep_description": "Хранит вашу почту, календарь, контакты и выбранные файлы в зашифрованном виде в этом браузере. Без сети можно читать, помечать и перемещать письма, а написанное ждёт в исходящих. При выходе всё удаляется.", + "window_label": "За какой период хранить", + "window_description": "Более старые письма и события календаря удаляются с этого устройства. Их по-прежнему можно открыть, когда есть сеть.", + "window_days": "{days, plural, one {# день} few {# дня} many {# дней} other {# дня}}", + "window_year": "1 год", + "window_everything": "Всё", + "attachments_label": "Хранить вложения", + "attachments_description": "Вложения сохранённых писем и файлы, которые вы храните без сети, всего до {total}. Самые старые удаляются первыми.", + "total_locked": "Ваша организация разрешает не более {size} вложений и файлов.", + "attachment_cap_label": "Самое большое хранимое вложение", + "usage_mail": "Письма и поисковый индекс", + "usage_attachments": "Вложения", + "usage_calendar": "Календарь", + "usage_contacts": "Контакты", + "usage_files": "Файлы, хранимые без сети", + "usage_row": "{size} ({count, plural, one {# элемент} few {# элемента} many {# элементов} other {# элемента}})", + "progress_list": "Составляется список писем", + "progress_bodies": "Загружаются письма", + "progress_threads": "Сортируются цепочки писем", + "progress_files": "Загружаются файлы", + "progress_other": "Данные переносятся на это устройство", + "progress_count": "{done} из {total}", + "progress_count_open": "пока {done}", + "progress_left": "осталось примерно {minutes, plural, one {# минута} few {# минуты} many {# минут} other {# минуты}}", + "clear_label": "Очистить эту учётную запись", + "clear_description": "Удаляет всё, что это устройство хранит для этой учётной записи, и загружает заново.", + "clear_button": "Очистить…", + "clear_confirm_title": "Очистить эту учётную запись на этом устройстве?", + "clear_confirm_message": "Всё, что это устройство хранит для этой учётной записи, будет удалено и загружено заново. Ваша почта на сервере останется.", + "clear_confirm_unsent": "{count, plural, one {# неотправленное письмо будет потеряно.} few {# неотправленных письма будут потеряны.} many {# неотправленных писем будут потеряны.} other {# неотправленного письма будет потеряно.}}", + "clear_confirm": "Очистить", + "persist_refused": "Этот браузер может удалить сохранённую почту, когда не хватает места. Установка приложения обычно это предотвращает.", + "persist_retry": "Спросить снова", + "safari_hint": "Safari удаляет данные сайта, если его не открывали 7 дней. Добавьте Bulwark на экран «Домой» или в Dock, чтобы почта оставалась на этом устройстве.", + "evicted": "Браузер удалил почту, сохранённую на этом устройстве. Она загружается заново.", + "evicted_lost": "{count, plural, one {Потеряно # неотправленное письмо или изменение.} few {Потеряно # неотправленных письма или изменения.} many {Потеряно # неотправленных писем или изменений.} other {Потеряно # неотправленного письма или изменения.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Память устройства заполнена.", + "storage_full_text": "Bulwark больше не сохраняет здесь почту. Храните меньше писем или очистите эту учётную запись, чтобы освободить место.", + "open_settings": "Открыть настройки", + "default_on": "Bulwark хранит вашу почту на этом устройстве, чтобы она работала без сети. Это можно изменить в настройках.", + "conflict_calendar": "Событие календаря", + "conflict_contacts": "Контакт", + "kept_files_title": "Файлы, хранимые без сети", + "kept_state_kept": "На этом устройстве", + "kept_state_waiting": "Ожидает загрузки", + "kept_error_tooLarge": "Слишком большой для хранения", + "kept_error_overLimit": "Превышен лимит этого устройства", + "kept_error_notAllowed": "Ваша организация не разрешает хранить файлы", + "kept_error_download": "Не удалось загрузить", + "keep_offline": "Хранить без сети", + "unpin": "Больше не хранить без сети", + "unpin_label": "Больше не хранить {name} без сети" + }, "deep_link": { "message_not_found": "Это письмо больше недоступно.", "thread_not_found": "Эта переписка больше недоступна.", diff --git a/locales/sk/common.json b/locales/sk/common.json index 13b2e0ae2..706c90fe2 100644 --- a/locales/sk/common.json +++ b/locales/sk/common.json @@ -5756,6 +5756,61 @@ "toast": "Nepoužité zmeny urobené offline: {count}. Ktoré to sú, ukazuje pošta na odoslanie.", "storage_failed": "V tomto zariadení už nie je miesto na poštu offline. Uvoľnite miesto alebo v nastaveniach ponechajte menej." }, + "offlineStorage": { + "keep_description": "Uchováva vašu poštu, kalendár, kontakty a vybrané súbory zašifrované v tomto prehliadači. Offline môžete poštu čítať, označovať a presúvať a to, čo napíšete, čaká na odoslanie. Odhlásenie všetko odstráni.", + "window_label": "Ako dlho do minulosti uchovávať", + "window_description": "Staršia pošta a udalosti z kalendára toto zariadenie opustia. Keď budete online, môžete ich stále otvoriť.", + "window_days": "{days, plural, one {# deň} few {# dni} many {# dňa} other {# dní}}", + "window_year": "1 rok", + "window_everything": "Všetko", + "attachments_label": "Uchovávať prílohy", + "attachments_description": "Prílohy uchovaných správ a súbory, ktoré uchovávate offline, spolu až {total}. Najstaršie sa odstránia ako prvé.", + "total_locked": "Vaša organizácia povoľuje najviac {size} príloh a súborov.", + "attachment_cap_label": "Najväčšia uchovávaná príloha", + "usage_mail": "Správy a index vyhľadávania", + "usage_attachments": "Prílohy", + "usage_calendar": "Kalendár", + "usage_contacts": "Kontakty", + "usage_files": "Súbory uchované offline", + "usage_row": "{size} ({count, plural, one {# položka} few {# položky} many {# položky} other {# položiek}})", + "progress_list": "Vypisujú sa správy", + "progress_bodies": "Sťahujú sa správy", + "progress_threads": "Radia sa konverzácie", + "progress_files": "Sťahujú sa súbory", + "progress_other": "Prenášajú sa dáta do tohto zariadenia", + "progress_count": "{done} z {total}", + "progress_count_open": "zatiaľ {done}", + "progress_left": "zostáva asi {minutes, plural, one {# minúta} few {# minúty} many {# minúty} other {# minút}}", + "clear_label": "Vymazať tento účet", + "clear_description": "Zmaže všetko, čo toto zariadenie pre tento účet uchováva, a stiahne to znova.", + "clear_button": "Vymazať…", + "clear_confirm_title": "Vymazať tento účet na tomto zariadení?", + "clear_confirm_message": "Všetko, čo toto zariadenie pre tento účet uchováva, sa zmaže a stiahne znova. Vaša pošta na serveri zostane.", + "clear_confirm_unsent": "{count, plural, one {# neodoslaná správa sa stratí.} few {# neodoslané správy sa stratia.} many {# neodoslanej správy sa stratí.} other {# neodoslaných správ sa stratí.}}", + "clear_confirm": "Vymazať", + "persist_refused": "Tento prehliadač môže uchovanú poštu zmazať, keď dôjde miesto. Inštalácia aplikácie tomu zvyčajne zabráni.", + "persist_retry": "Opýtať sa znova", + "safari_hint": "Safari zmaže dáta webu po 7 dňoch bez návštevy. Pridajte Bulwark na plochu alebo do Docku, aby vaša pošta na tomto zariadení zostala.", + "evicted": "Prehliadač zmazal poštu uchovanú na tomto zariadení. Sťahuje sa znova.", + "evicted_lost": "{count, plural, one {# neodoslaná správa alebo zmena sa stratila.} few {# neodoslané správy alebo zmeny sa stratili.} many {# neodoslanej správy alebo zmeny sa stratilo.} other {# neodoslaných správ alebo zmien sa stratilo.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Úložisko zariadenia je plné.", + "storage_full_text": "Bulwark sem prestal ukladať poštu. Uchovávajte menej pošty alebo vymažte tento účet, aby sa uvoľnilo miesto.", + "open_settings": "Otvoriť nastavenia", + "default_on": "Bulwark uchováva vašu poštu na tomto zariadení, aby fungoval aj bez pripojenia. Môžete to zmeniť v Nastaveniach.", + "conflict_calendar": "Udalosť v kalendári", + "conflict_contacts": "Kontakt", + "kept_files_title": "Súbory uchované offline", + "kept_state_kept": "Na tomto zariadení", + "kept_state_waiting": "Čaká na stiahnutie", + "kept_error_tooLarge": "Príliš veľký na uchovanie", + "kept_error_overLimit": "Nad limit tohto zariadenia", + "kept_error_notAllowed": "Vaša organizácia uchovávanie súborov nepovoľuje", + "kept_error_download": "Nepodarilo sa stiahnuť", + "keep_offline": "Uchovať offline", + "unpin": "Prestať uchovávať offline", + "unpin_label": "Prestať uchovávať {name} offline" + }, "deep_link": { "message_not_found": "Táto správa už nie je dostupná.", "thread_not_found": "Táto konverzácia už nie je dostupná.", diff --git a/locales/th/common.json b/locales/th/common.json index a1cb466d9..ce9b58928 100644 --- a/locales/th/common.json +++ b/locales/th/common.json @@ -2101,6 +2101,61 @@ "toast": "การเปลี่ยนแปลงขณะออฟไลน์ที่ไม่ได้นำไปใช้: {count} ดูรายการได้ในกล่องขาออก", "storage_failed": "อุปกรณ์นี้ไม่มีที่ว่างสำหรับอีเมลออฟไลน์แล้ว โปรดเพิ่มพื้นที่ว่างหรือเก็บให้น้อยลงในการตั้งค่า" }, + "offlineStorage": { + "keep_description": "เก็บอีเมล ปฏิทิน รายชื่อติดต่อ และไฟล์ที่คุณเลือกไว้ในเบราว์เซอร์นี้แบบเข้ารหัส เมื่อออฟไลน์คุณอ่าน ติดธง และย้ายอีเมลได้ และสิ่งที่คุณเขียนจะรออยู่ในกล่องขาออก เมื่อออกจากระบบทุกอย่างจะถูกลบ", + "window_label": "เก็บย้อนหลังนานแค่ไหน", + "window_description": "อีเมลและกิจกรรมในปฏิทินที่เก่ากว่านี้จะถูกนำออกจากอุปกรณ์นี้ คุณยังเปิดดูได้เมื่อออนไลน์", + "window_days": "{days, plural, other {# วัน}}", + "window_year": "1 ปี", + "window_everything": "ทั้งหมด", + "attachments_label": "เก็บไฟล์แนบ", + "attachments_description": "ไฟล์แนบของข้อความที่เก็บไว้และไฟล์ที่เก็บไว้ใช้ออฟไลน์ รวมกันไม่เกิน {total} ของที่เก่าที่สุดจะถูกลบก่อน", + "total_locked": "องค์กรของคุณอนุญาตไฟล์แนบและไฟล์รวมกันไม่เกิน {size}", + "attachment_cap_label": "ไฟล์แนบที่ใหญ่ที่สุดที่จะเก็บ", + "usage_mail": "ข้อความและดัชนีการค้นหา", + "usage_attachments": "ไฟล์แนบ", + "usage_calendar": "ปฏิทิน", + "usage_contacts": "รายชื่อติดต่อ", + "usage_files": "ไฟล์ที่เก็บไว้ใช้ออฟไลน์", + "usage_row": "{size} ({count, plural, other {# รายการ}})", + "progress_list": "กำลังแสดงรายการข้อความ", + "progress_bodies": "กำลังดาวน์โหลดข้อความ", + "progress_threads": "กำลังเรียงลำดับการสนทนา", + "progress_files": "กำลังดาวน์โหลดไฟล์", + "progress_other": "กำลังนำข้อมูลมาไว้ที่อุปกรณ์นี้", + "progress_count": "{done} จาก {total}", + "progress_count_open": "ตอนนี้ {done}", + "progress_left": "เหลือประมาณ {minutes, plural, other {# นาที}}", + "clear_label": "ล้างบัญชีนี้", + "clear_description": "ลบทุกอย่างที่อุปกรณ์นี้เก็บไว้สำหรับบัญชีนี้ แล้วดาวน์โหลดใหม่", + "clear_button": "ล้าง…", + "clear_confirm_title": "ล้างบัญชีนี้บนอุปกรณ์นี้ไหม", + "clear_confirm_message": "ทุกอย่างที่อุปกรณ์นี้เก็บไว้สำหรับบัญชีนี้จะถูกลบและดาวน์โหลดใหม่ อีเมลของคุณบนเซิร์ฟเวอร์ยังอยู่", + "clear_confirm_unsent": "{count, plural, other {ข้อความที่ยังไม่ได้ส่ง # ข้อความจะสูญหาย}}", + "clear_confirm": "ล้าง", + "persist_refused": "เบราว์เซอร์นี้อาจลบอีเมลที่เก็บไว้เมื่อพื้นที่เหลือน้อย การติดตั้งแอปมักช่วยป้องกันได้", + "persist_retry": "ขออีกครั้ง", + "safari_hint": "Safari จะลบข้อมูลของเว็บไซต์หลังจากไม่ได้เข้าชม 7 วัน เพิ่ม Bulwark ลงในหน้าจอโฮมหรือ Dock เพื่อเก็บอีเมลไว้บนอุปกรณ์นี้", + "evicted": "เบราว์เซอร์ลบอีเมลที่เก็บไว้บนอุปกรณ์นี้แล้ว กำลังดาวน์โหลดใหม่", + "evicted_lost": "{count, plural, other {ข้อความหรือการเปลี่ยนแปลงที่ยังไม่ได้ส่ง # รายการสูญหาย}}", + "evicted_dismiss": "ตกลง", + "storage_full_title": "พื้นที่เก็บข้อมูลของอุปกรณ์เต็ม", + "storage_full_text": "Bulwark หยุดบันทึกอีเมลที่นี่แล้ว เก็บอีเมลให้น้อยลงหรือล้างบัญชีนี้เพื่อเพิ่มพื้นที่", + "open_settings": "เปิดการตั้งค่า", + "default_on": "Bulwark เก็บอีเมลของคุณไว้บนอุปกรณ์นี้ เพื่อให้ใช้งานได้โดยไม่ต้องเชื่อมต่อ คุณเปลี่ยนได้ในการตั้งค่า", + "conflict_calendar": "กิจกรรมในปฏิทิน", + "conflict_contacts": "รายชื่อติดต่อ", + "kept_files_title": "ไฟล์ที่เก็บไว้ใช้ออฟไลน์", + "kept_state_kept": "บนอุปกรณ์นี้", + "kept_state_waiting": "รอดาวน์โหลด", + "kept_error_tooLarge": "ใหญ่เกินกว่าจะเก็บ", + "kept_error_overLimit": "เกินขีดจำกัดของอุปกรณ์นี้", + "kept_error_notAllowed": "องค์กรของคุณไม่อนุญาตให้เก็บไฟล์", + "kept_error_download": "ดาวน์โหลดไม่ได้", + "keep_offline": "เก็บไว้ใช้ออฟไลน์", + "unpin": "เลิกเก็บไว้ใช้ออฟไลน์", + "unpin_label": "เลิกเก็บ {name} ไว้ใช้ออฟไลน์" + }, "plugin_pages": { "loading": "กำลังโหลดหน้าเว็บ...", "not_available_title": "หน้านี้ไม่พร้อมใช้งาน", diff --git a/locales/tr/common.json b/locales/tr/common.json index 839601428..1d41f5f66 100644 --- a/locales/tr/common.json +++ b/locales/tr/common.json @@ -5756,6 +5756,61 @@ "toast": "Çevrimdışı yapılan ve uygulanmayan değişiklikler: {count}. Giden kutusu hangileri olduğunu gösterir.", "storage_failed": "Bu cihazda çevrimdışı e-posta için yer kalmadı. Yer açın veya Ayarlar'dan daha azını saklayın." }, + "offlineStorage": { + "keep_description": "E-postalarınızı, takviminizi, kişilerinizi ve seçtiğiniz dosyaları bu tarayıcıda şifreli olarak tutar. Çevrimdışıyken e-postaları okuyabilir, işaretleyebilir ve taşıyabilirsiniz; yazdıklarınız giden kutusunda bekler. Oturumu kapatınca hepsi silinir.", + "window_label": "Ne kadar geriye tutulsun", + "window_description": "Daha eski e-postalar ve takvim etkinlikleri bu cihazdan kaldırılır. Bağlantınız olduğunda yine açabilirsiniz.", + "window_days": "{days, plural, one {# gün} other {# gün}}", + "window_year": "1 yıl", + "window_everything": "Hepsi", + "attachments_label": "Ekleri tut", + "attachments_description": "Tutulan iletilerin ekleri ve çevrimdışı tuttuğunuz dosyalar, toplam en fazla {total}. En eskiler önce silinir.", + "total_locked": "Kuruluşunuz en fazla {size} ek ve dosyaya izin veriyor.", + "attachment_cap_label": "Tutulacak en büyük ek", + "usage_mail": "İletiler ve arama dizini", + "usage_attachments": "Ekler", + "usage_calendar": "Takvim", + "usage_contacts": "Kişiler", + "usage_files": "Çevrimdışı tutulan dosyalar", + "usage_row": "{size} ({count, plural, one {# öğe} other {# öğe}})", + "progress_list": "İletiler listeleniyor", + "progress_bodies": "İletiler indiriliyor", + "progress_threads": "Konuşmalar sıralanıyor", + "progress_files": "Dosyalar indiriliyor", + "progress_other": "Veriler bu cihaza getiriliyor", + "progress_count": "{done} / {total}", + "progress_count_open": "şimdiye kadar {done}", + "progress_left": "yaklaşık {minutes, plural, one {# dakika} other {# dakika}} kaldı", + "clear_label": "Bu hesabı temizle", + "clear_description": "Bu cihazın bu hesap için tuttuğu her şeyi siler, sonra yeniden indirir.", + "clear_button": "Temizle…", + "clear_confirm_title": "Bu hesap bu cihazda temizlensin mi?", + "clear_confirm_message": "Bu cihazın bu hesap için tuttuğu her şey silinir ve yeniden indirilir. Sunucudaki e-postalarınız kalır.", + "clear_confirm_unsent": "{count, plural, one {# gönderilmemiş ileti kaybolacak.} other {# gönderilmemiş ileti kaybolacak.}}", + "clear_confirm": "Temizle", + "persist_refused": "Alan azaldığında bu tarayıcı tutulan e-postaları silebilir. Uygulamayı yüklemek genellikle bunu önler.", + "persist_retry": "Yeniden sor", + "safari_hint": "Safari, 7 gün ziyaret edilmeyen bir sitenin verilerini siler. E-postalarınızı bu cihazda tutmak için Bulwark'ı Ana Ekran'a veya Dock'a ekleyin.", + "evicted": "Tarayıcı, bu cihazda tutulan e-postaları sildi. Yeniden indiriliyor.", + "evicted_lost": "{count, plural, one {# gönderilmemiş ileti veya değişiklik kayboldu.} other {# gönderilmemiş ileti veya değişiklik kayboldu.}}", + "evicted_dismiss": "Tamam", + "storage_full_title": "Cihaz depolama alanı dolu.", + "storage_full_text": "Bulwark artık buraya e-posta kaydetmiyor. Daha az e-posta tutun veya yer açmak için bu hesabı temizleyin.", + "open_settings": "Ayarları aç", + "default_on": "Bulwark, bağlantı olmadan da çalışması için e-postalarınızı bu cihazda tutar. Bunu Ayarlar'dan değiştirebilirsiniz.", + "conflict_calendar": "Takvim etkinliği", + "conflict_contacts": "Kişi", + "kept_files_title": "Çevrimdışı tutulan dosyalar", + "kept_state_kept": "Bu cihazda", + "kept_state_waiting": "İndirilmeyi bekliyor", + "kept_error_tooLarge": "Tutulamayacak kadar büyük", + "kept_error_overLimit": "Bu cihazın sınırını aşıyor", + "kept_error_notAllowed": "Kuruluşunuz dosyaların tutulmasına izin vermiyor", + "kept_error_download": "İndirilemedi", + "keep_offline": "Çevrimdışı tut", + "unpin": "Çevrimdışı tutmayı bırak", + "unpin_label": "{name} dosyasını çevrimdışı tutmayı bırak" + }, "deep_link": { "message_not_found": "Bu ileti artık kullanılamıyor.", "thread_not_found": "Bu sohbet artık kullanılamıyor.", diff --git a/locales/uk/common.json b/locales/uk/common.json index e9ab2cd21..f18e2f092 100644 --- a/locales/uk/common.json +++ b/locales/uk/common.json @@ -5756,6 +5756,61 @@ "toast": "Зміни, внесені офлайн і не застосовані: {count}. Які саме, видно у вихідних.", "storage_failed": "На цьому пристрої не залишилося місця для офлайн-пошти. Звільніть місце або зберігайте менше в налаштуваннях." }, + "offlineStorage": { + "keep_description": "Зберігає вашу пошту, календар, контакти та вибрані файли в зашифрованому вигляді в цьому браузері. Без мережі можна читати, позначати й переміщати листи, а написане чекає у вихідних. Під час виходу все видаляється.", + "window_label": "За який період зберігати", + "window_description": "Старіші листи й події календаря видаляються з цього пристрою. Їх і надалі можна відкрити, коли є мережа.", + "window_days": "{days, plural, one {# день} few {# дні} many {# днів} other {# дня}}", + "window_year": "1 рік", + "window_everything": "Усе", + "attachments_label": "Зберігати вкладення", + "attachments_description": "Вкладення збережених листів і файли, які ви зберігаєте без мережі, разом до {total}. Найстаріші видаляються першими.", + "total_locked": "Ваша організація дозволяє щонайбільше {size} вкладень і файлів.", + "attachment_cap_label": "Найбільше вкладення, яке зберігається", + "usage_mail": "Листи та пошуковий індекс", + "usage_attachments": "Вкладення", + "usage_calendar": "Календар", + "usage_contacts": "Контакти", + "usage_files": "Файли, збережені без мережі", + "usage_row": "{size} ({count, plural, one {# елемент} few {# елементи} many {# елементів} other {# елемента}})", + "progress_list": "Складається список листів", + "progress_bodies": "Завантажуються листи", + "progress_threads": "Сортуються розмови", + "progress_files": "Завантажуються файли", + "progress_other": "Дані переносяться на цей пристрій", + "progress_count": "{done} із {total}", + "progress_count_open": "поки {done}", + "progress_left": "залишилося приблизно {minutes, plural, one {# хвилина} few {# хвилини} many {# хвилин} other {# хвилини}}", + "clear_label": "Очистити цей обліковий запис", + "clear_description": "Видаляє все, що цей пристрій зберігає для цього облікового запису, і завантажує знову.", + "clear_button": "Очистити…", + "clear_confirm_title": "Очистити цей обліковий запис на цьому пристрої?", + "clear_confirm_message": "Усе, що цей пристрій зберігає для цього облікового запису, буде видалено й завантажено знову. Ваша пошта на сервері залишиться.", + "clear_confirm_unsent": "{count, plural, one {# невідправлений лист буде втрачено.} few {# невідправлені листи буде втрачено.} many {# невідправлених листів буде втрачено.} other {# невідправленого листа буде втрачено.}}", + "clear_confirm": "Очистити", + "persist_refused": "Цей браузер може видалити збережену пошту, коли бракує місця. Встановлення застосунку зазвичай цьому запобігає.", + "persist_retry": "Запитати знову", + "safari_hint": "Safari видаляє дані сайту, якщо його не відвідували 7 днів. Додайте Bulwark на екран «Додому» або в Dock, щоб пошта залишалася на цьому пристрої.", + "evicted": "Браузер видалив пошту, збережену на цьому пристрої. Вона завантажується знову.", + "evicted_lost": "{count, plural, one {Втрачено # невідправлений лист або зміну.} few {Втрачено # невідправлені листи або зміни.} many {Втрачено # невідправлених листів або змін.} other {Втрачено # невідправленого листа або зміни.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Пам'ять пристрою заповнена.", + "storage_full_text": "Bulwark більше не зберігає тут пошту. Зберігайте менше листів або очистьте цей обліковий запис, щоб звільнити місце.", + "open_settings": "Відкрити налаштування", + "default_on": "Bulwark зберігає вашу пошту на цьому пристрої, щоб вона працювала без мережі. Це можна змінити в налаштуваннях.", + "conflict_calendar": "Подія календаря", + "conflict_contacts": "Контакт", + "kept_files_title": "Файли, збережені без мережі", + "kept_state_kept": "На цьому пристрої", + "kept_state_waiting": "Очікує завантаження", + "kept_error_tooLarge": "Завеликий для зберігання", + "kept_error_overLimit": "Перевищено ліміт цього пристрою", + "kept_error_notAllowed": "Ваша організація не дозволяє зберігати файли", + "kept_error_download": "Не вдалося завантажити", + "keep_offline": "Зберігати без мережі", + "unpin": "Більше не зберігати без мережі", + "unpin_label": "Більше не зберігати {name} без мережі" + }, "deep_link": { "message_not_found": "Цей лист більше недоступний.", "thread_not_found": "Ця розмова більше недоступна.", diff --git a/locales/vi/common.json b/locales/vi/common.json index 2c242d359..a1b0f4125 100644 --- a/locales/vi/common.json +++ b/locales/vi/common.json @@ -5768,6 +5768,61 @@ "toast": "Thay đổi khi ngoại tuyến chưa được áp dụng: {count}. Hộp thư đi cho biết là những thay đổi nào.", "storage_failed": "Thiết bị này không còn chỗ cho thư ngoại tuyến. Hãy giải phóng dung lượng hoặc giữ ít hơn trong Cài đặt." }, + "offlineStorage": { + "keep_description": "Giữ thư, lịch, danh bạ và các tệp bạn chọn, được mã hóa trong trình duyệt này. Khi ngoại tuyến bạn có thể đọc, gắn cờ và di chuyển thư, còn thư bạn viết sẽ chờ trong Hộp thư đi. Khi đăng xuất, tất cả sẽ bị xóa.", + "window_label": "Giữ lại bao lâu", + "window_description": "Thư và sự kiện lịch cũ hơn sẽ bị xóa khỏi thiết bị này. Bạn vẫn có thể mở chúng khi có kết nối.", + "window_days": "{days, plural, other {# ngày}}", + "window_year": "1 năm", + "window_everything": "Tất cả", + "attachments_label": "Giữ tệp đính kèm", + "attachments_description": "Tệp đính kèm của các thư được giữ và các tệp bạn giữ ngoại tuyến, tối đa {total} tổng cộng. Tệp cũ nhất sẽ bị xóa trước.", + "total_locked": "Tổ chức của bạn chỉ cho phép tối đa {size} tệp đính kèm và tệp.", + "attachment_cap_label": "Tệp đính kèm lớn nhất được giữ", + "usage_mail": "Thư và chỉ mục tìm kiếm", + "usage_attachments": "Tệp đính kèm", + "usage_calendar": "Lịch", + "usage_contacts": "Danh bạ", + "usage_files": "Tệp giữ ngoại tuyến", + "usage_row": "{size} ({count, plural, other {# mục}})", + "progress_list": "Đang liệt kê thư", + "progress_bodies": "Đang tải thư xuống", + "progress_threads": "Đang sắp xếp cuộc trò chuyện", + "progress_files": "Đang tải tệp xuống", + "progress_other": "Đang đưa dữ liệu về thiết bị này", + "progress_count": "{done} trên {total}", + "progress_count_open": "đến nay {done}", + "progress_left": "còn khoảng {minutes, plural, other {# phút}}", + "clear_label": "Xóa tài khoản này", + "clear_description": "Xóa mọi thứ thiết bị này giữ cho tài khoản này, rồi tải lại.", + "clear_button": "Xóa…", + "clear_confirm_title": "Xóa tài khoản này trên thiết bị này?", + "clear_confirm_message": "Mọi thứ thiết bị này giữ cho tài khoản này sẽ bị xóa và tải lại. Thư của bạn trên máy chủ vẫn còn.", + "clear_confirm_unsent": "{count, plural, other {# thư chưa gửi sẽ bị mất.}}", + "clear_confirm": "Xóa", + "persist_refused": "Trình duyệt này có thể xóa thư đã giữ khi sắp hết dung lượng. Cài đặt ứng dụng thường giúp tránh điều này.", + "persist_retry": "Hỏi lại", + "safari_hint": "Safari xóa dữ liệu của một trang web sau 7 ngày không truy cập. Hãy thêm Bulwark vào Màn hình chính hoặc Dock để giữ thư trên thiết bị này.", + "evicted": "Trình duyệt đã xóa thư được giữ trên thiết bị này. Đang tải lại.", + "evicted_lost": "{count, plural, other {# thư hoặc thay đổi chưa gửi đã bị mất.}}", + "evicted_dismiss": "OK", + "storage_full_title": "Bộ nhớ thiết bị đã đầy.", + "storage_full_text": "Bulwark đã ngừng lưu thư ở đây. Hãy giữ ít thư hơn hoặc xóa tài khoản này để có thêm chỗ.", + "open_settings": "Mở cài đặt", + "default_on": "Bulwark giữ thư của bạn trên thiết bị này để dùng được khi không có kết nối. Bạn có thể đổi điều này trong Cài đặt.", + "conflict_calendar": "Sự kiện lịch", + "conflict_contacts": "Liên hệ", + "kept_files_title": "Tệp giữ ngoại tuyến", + "kept_state_kept": "Trên thiết bị này", + "kept_state_waiting": "Đang chờ tải xuống", + "kept_error_tooLarge": "Quá lớn để giữ", + "kept_error_overLimit": "Vượt giới hạn của thiết bị này", + "kept_error_notAllowed": "Tổ chức của bạn không cho phép giữ tệp", + "kept_error_download": "Không tải xuống được", + "keep_offline": "Giữ ngoại tuyến", + "unpin": "Ngừng giữ ngoại tuyến", + "unpin_label": "Ngừng giữ {name} ngoại tuyến" + }, "deep_link": { "message_not_found": "Thư này không còn nữa.", "thread_not_found": "Cuộc trò chuyện này không còn tồn tại nữa.", diff --git a/locales/zh-TW/common.json b/locales/zh-TW/common.json index dc8d0f4bf..261013184 100644 --- a/locales/zh-TW/common.json +++ b/locales/zh-TW/common.json @@ -5756,6 +5756,61 @@ "toast": "離線時的變更未被套用：{count} 項。可在寄件匣中查看。", "storage_failed": "此裝置已沒有空間存放離線郵件。請釋出空間，或在設定中減少保留的內容。" }, + "offlineStorage": { + "keep_description": "在此瀏覽器中加密保留你的郵件、行事曆、聯絡人和你選擇的檔案。離線時可以閱讀、標記和移動郵件，寫好的郵件會在寄件匣中等待。登出時會全部刪除。", + "window_label": "保留多久以內的內容", + "window_description": "更早的郵件和行事曆活動會從此裝置移除。連線時你仍可以開啟它們。", + "window_days": "{days, plural, other {# 天}}", + "window_year": "1 年", + "window_everything": "全部", + "attachments_label": "保留附件", + "attachments_description": "已保留郵件的附件和你離線保留的檔案，總共最多 {total}。最舊的先刪除。", + "total_locked": "你的組織最多允許 {size} 的附件和檔案。", + "attachment_cap_label": "保留的最大附件", + "usage_mail": "郵件和搜尋索引", + "usage_attachments": "附件", + "usage_calendar": "行事曆", + "usage_contacts": "聯絡人", + "usage_files": "離線保留的檔案", + "usage_row": "{size}（{count, plural, other {# 項}}）", + "progress_list": "正在列出郵件", + "progress_bodies": "正在下載郵件", + "progress_threads": "正在整理對話", + "progress_files": "正在下載檔案", + "progress_other": "正在把資料帶到此裝置", + "progress_count": "{done} / {total}", + "progress_count_open": "已完成 {done}", + "progress_left": "還剩約 {minutes, plural, other {# 分鐘}}", + "clear_label": "清除此帳號", + "clear_description": "刪除此裝置為該帳號保留的全部內容，然後重新下載。", + "clear_button": "清除…", + "clear_confirm_title": "在此裝置上清除該帳號？", + "clear_confirm_message": "此裝置為該帳號保留的全部內容會被刪除並重新下載。伺服器上的郵件不受影響。", + "clear_confirm_unsent": "{count, plural, other {# 封未寄出的郵件將會遺失。}}", + "clear_confirm": "清除", + "persist_refused": "儲存空間不足時，此瀏覽器可能會刪除保留的郵件。安裝應用程式通常可以避免這種情況。", + "persist_retry": "再次請求", + "safari_hint": "Safari 會在網站 7 天未造訪後刪除其資料。把 Bulwark 加入主畫面或 Dock，郵件就能保留在此裝置上。", + "evicted": "瀏覽器刪除了此裝置上保留的郵件。正在重新下載。", + "evicted_lost": "{count, plural, other {# 封未寄出的郵件或變更已遺失。}}", + "evicted_dismiss": "好", + "storage_full_title": "裝置儲存空間已滿。", + "storage_full_text": "Bulwark 已停止在此儲存郵件。請少保留一些郵件，或清除此帳號來騰出空間。", + "open_settings": "開啟設定", + "default_on": "Bulwark 會把你的郵件保留在此裝置上，這樣沒有網路也能使用。你可以在設定中變更。", + "conflict_calendar": "行事曆活動", + "conflict_contacts": "聯絡人", + "kept_files_title": "離線保留的檔案", + "kept_state_kept": "在此裝置上", + "kept_state_waiting": "等待下載", + "kept_error_tooLarge": "太大，無法保留", + "kept_error_overLimit": "超出此裝置的限制", + "kept_error_notAllowed": "你的組織不允許保留檔案", + "kept_error_download": "無法下載", + "keep_offline": "離線保留", + "unpin": "不再離線保留", + "unpin_label": "不再離線保留 {name}" + }, "deep_link": { "message_not_found": "已無法使用此郵件。", "thread_not_found": "已無法使用此對話串。", diff --git a/locales/zh/common.json b/locales/zh/common.json index bc7da9471..ae36afa3e 100644 --- a/locales/zh/common.json +++ b/locales/zh/common.json @@ -5756,6 +5756,61 @@ "toast": "离线时的更改未被应用：{count} 项。可在发件箱中查看。", "storage_failed": "此设备已没有空间存放离线邮件。请释放空间，或在设置中减少保留的内容。" }, + "offlineStorage": { + "keep_description": "在此浏览器中加密保留你的邮件、日历、联系人和你选择的文件。离线时可以阅读、标记和移动邮件，写好的邮件会在发件箱中等待。退出登录时会全部删除。", + "window_label": "保留多久以内的内容", + "window_description": "更早的邮件和日历事件会从此设备中移除。联网时你仍可以打开它们。", + "window_days": "{days, plural, other {# 天}}", + "window_year": "1 年", + "window_everything": "全部", + "attachments_label": "保留附件", + "attachments_description": "已保留邮件的附件和你离线保留的文件，总共最多 {total}。最旧的先删除。", + "total_locked": "你的组织最多允许 {size} 的附件和文件。", + "attachment_cap_label": "保留的最大附件", + "usage_mail": "邮件和搜索索引", + "usage_attachments": "附件", + "usage_calendar": "日历", + "usage_contacts": "联系人", + "usage_files": "离线保留的文件", + "usage_row": "{size}（{count, plural, other {# 项}}）", + "progress_list": "正在列出邮件", + "progress_bodies": "正在下载邮件", + "progress_threads": "正在整理会话", + "progress_files": "正在下载文件", + "progress_other": "正在把数据带到此设备", + "progress_count": "{done} / {total}", + "progress_count_open": "已完成 {done}", + "progress_left": "还剩约 {minutes, plural, other {# 分钟}}", + "clear_label": "清除此账户", + "clear_description": "删除此设备为该账户保留的全部内容，然后重新下载。", + "clear_button": "清除…", + "clear_confirm_title": "在此设备上清除该账户？", + "clear_confirm_message": "此设备为该账户保留的全部内容会被删除并重新下载。服务器上的邮件不受影响。", + "clear_confirm_unsent": "{count, plural, other {# 封未发送的邮件将丢失。}}", + "clear_confirm": "清除", + "persist_refused": "存储空间不足时，此浏览器可能会删除保留的邮件。安装应用通常可以避免这种情况。", + "persist_retry": "再次请求", + "safari_hint": "Safari 会在网站 7 天未访问后删除其数据。把 Bulwark 添加到主屏幕或程序坞，邮件就能保留在此设备上。", + "evicted": "浏览器删除了此设备上保留的邮件。正在重新下载。", + "evicted_lost": "{count, plural, other {# 封未发送的邮件或更改已丢失。}}", + "evicted_dismiss": "好", + "storage_full_title": "设备存储空间已满。", + "storage_full_text": "Bulwark 已停止在此保存邮件。请少保留一些邮件，或清除此账户来腾出空间。", + "open_settings": "打开设置", + "default_on": "Bulwark 会把你的邮件保留在此设备上，这样没有网络也能使用。你可以在设置中更改。", + "conflict_calendar": "日历事件", + "conflict_contacts": "联系人", + "kept_files_title": "离线保留的文件", + "kept_state_kept": "在此设备上", + "kept_state_waiting": "等待下载", + "kept_error_tooLarge": "太大，无法保留", + "kept_error_overLimit": "超出此设备的限制", + "kept_error_notAllowed": "你的组织不允许保留文件", + "kept_error_download": "无法下载", + "keep_offline": "离线保留", + "unpin": "不再离线保留", + "unpin_label": "不再离线保留 {name}" + }, "deep_link": { "message_not_found": "此邮件已不可用。", "thread_not_found": "此会话已不可用。", From b4d43d9bbe10339364c4edb2875e29228b0e76a8 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 09:17:57 +0100 Subject: [PATCH 12/20] test: check what a device keeps on both servers, down to the raw bytes --- components/offline/account-storage.tsx | 2 +- integration/tests/22-ent-offline.spec.ts | 290 +++++++++++++++++++++++ 2 files changed, 291 insertions(+), 1 deletion(-) diff --git a/components/offline/account-storage.tsx b/components/offline/account-storage.tsx index e3ebf9c73..f86ed4a8b 100644 --- a/components/offline/account-storage.tsx +++ b/components/offline/account-storage.tsx @@ -128,7 +128,7 @@ export function AccountStorage({ account, primary, heading }: { account: string; {syncing && progressWorthShowing(progress) && } {usage && usage.parts.length > 0 && (
    - {usage.parts.map((part) => ( + {usage.parts.filter((part) => part.items > 0).map((part) => (
    {tStorage(`usage_${part.part}`)}
    {tStorage('usage_row', { size: formatFileSize(part.bytes), count: part.items })}
    diff --git a/integration/tests/22-ent-offline.spec.ts b/integration/tests/22-ent-offline.spec.ts index ff4dcd3cf..694c02931 100644 --- a/integration/tests/22-ent-offline.spec.ts +++ b/integration/tests/22-ent-offline.spec.ts @@ -590,6 +590,296 @@ test('at 390 px: the offline settings, the outbox and the reload prompt fit', as await page.context().close(); }); +// ---- What a device keeps (design A4, A7, A8, A9) ---- + +/** A message from long ago, in ent-alice's Inbox. Email/import takes the received date. */ +async function importOld(account: string, subject: string, daysAgo: number): Promise { + const client = await jmapAs(account); + const receivedAt = new Date(Date.now() - daysAgo * 86_400_000).toISOString().replace(/\.\d+Z$/, 'Z'); + const raw = `From: ${ENT.bob}\r\nTo: ${account}\r\nSubject: ${subject}\r\nDate: ${new Date(receivedAt).toUTCString()}\r\nMessage-ID: <${subject.replace(/\W/g, '')}@example.org>\r\nContent-Type: text/plain\r\n\r\nOld body ${RUN}\r\n`; + const auth = 'Basic ' + Buffer.from(`${account}:${process.env.IT_ENT_PASSWORD}`).toString('base64'); + const upload = await fetch(`${JMAP_URL}/jmap/upload/${client.accountId}/`, { method: 'POST', headers: { Authorization: auth, 'Content-Type': 'message/rfc822' }, body: raw }); + if (!upload.ok) throw new Error(`upload: ${upload.status}`); + const { blobId } = await upload.json() as { blobId: string }; + const boxes = await client.request([['Mailbox/query', { accountId: client.accountId, filter: { role: 'inbox' } }, '0']]); + const inbox = boxes.methodResponses[0][1].ids[0] as string; + const done = await client.request([['Email/import', { accountId: client.accountId, emails: { a: { blobId, mailboxIds: { [inbox]: true }, keywords: {}, receivedAt } } }, '0']]); + if (!done.methodResponses[0][1].created?.a) throw new Error(`import: ${JSON.stringify(done.methodResponses[0][1])}`); +} + +/** How many messages the settings page says are kept. */ +async function keptMessages(page: Page): Promise { + const text = await page.getByTestId('offline-usage').locator('[data-part="mail"] dd').innerText(); + return Number(text.match(/\(([\d.,]+) /)?.[1].replace(/[.,]/g, '') ?? NaN); +} + +async function statusSettled(page: Page): Promise { + await expect(page.getByTestId('offline-status')).toContainText('updated', { timeout: 180_000 }); +} + +test('a cap from the organisation prunes kept mail at the next policy fetch, and lifting it fetches the mail back', async ({ browser }) => { + const old = `Old message ${RUN}`; + await importOld(ENT.alice, old, 200); + const page = await userPage(browser, ENT.alice); + await enableOffline(page); + const windowRow = page.locator('[data-search-label="How far back to keep"]'); + await windowRow.locator('select').selectOption('all'); + await expect.poll(() => keptMessages(page), { timeout: 120_000 }).toBeGreaterThan(0); + await statusSettled(page); + await expect(async () => { + await page.getByTestId('offline-status').waitFor(); + const client = await jmapAs(ENT.alice); + const total = await client.request([['Email/query', { accountId: client.accountId, calculateTotal: true, limit: 0 }, '0']]); + expect(await keptMessages(page)).toBe(total.methodResponses[0][1].total); + }).toPass({ timeout: 180_000, intervals: [2000] }); + const before = await keptMessages(page); + + await setPolicy(browser, { organisation: { devices: { offlineMaxDays: 30, noOfflineAttachments: true } } }); + await page.reload(); + await expect(windowRow.locator('select')).toHaveValue('30', { timeout: 60_000 }); + await expect(windowRow.locator('select option')).toHaveText(['30 days']); + await expect(windowRow.getByText('Set by your organisation')).toBeVisible(); + const attachments = page.getByTestId('offline-attachments'); + await expect(attachments).toHaveAttribute('aria-checked', 'false'); + await expect(page.locator('[data-search-label="Keep attachments"]').getByText('Set by your organisation')).toBeVisible(); + await expect.poll(() => keptMessages(page), { timeout: 60_000 }).toBeLessThan(before); + await windowRow.scrollIntoViewIfNeeded(); + await shot(page, 'do-storage-page-capped'); + + // Offline, the old message isn't there either: it left the device, not only the list. + await toMail(page); + await blockMailServer(page.context()); + await waitUntilOffline(page); + await page.goto('/mail?q=' + encodeURIComponent(`"Old message"`)).catch(() => {}); + await expect(page.locator('[data-testid="email-list-item"]', { hasText: old })).toHaveCount(0); + await page.context().unroute(`${new URL(JMAP_URL).origin}/**`); + + await setPolicy(browser, {}); + await page.goto('/settings/backup/offline'); + await expect(windowRow.locator('select')).toHaveValue('all', { timeout: 60_000 }); + await expect.poll(() => keptMessages(page), { timeout: 180_000, intervals: [2000] }).toBe(before); + await page.context().close(); +}); + +test('the storage page: usage, choices, clearing an account', async ({ browser }) => { + const subject = `Cleared and fetched again ${RUN}`; + await deliverAndWait(subject, `Body ${RUN}`); + const page = await userPage(browser, ENT.alice); + await enableOffline(page); + await expect(page.getByTestId('offline-usage')).toContainText('Messages and search index'); + await expect.poll(() => keptMessages(page), { timeout: 60_000 }).toBeGreaterThan(0); + await shot(page, 'do-storage-page'); + + // Keyboard: the choices are native controls in tab order, and the state survives a reload. + const select = page.locator('[data-search-label="How far back to keep"] select'); + await select.focus(); + await select.selectOption('365'); + await page.reload(); + await expect(select).toHaveValue('365', { timeout: 60_000 }); + await expect(page.getByTestId('offline-status')).toContainText('updated', { timeout: 180_000 }); + + const before = await page.evaluate(async () => { + const db = await new Promise((resolve, reject) => { const r = indexedDB.open('bulwark-store'); r.onsuccess = () => resolve(r.result); r.onerror = () => reject(r.error); }); + const all = await new Promise>((resolve) => { const r = db.transaction('accounts').objectStore('accounts').getAll(); r.onsuccess = () => resolve(r.result); }); + db.close(); + return all.map((record) => record.file); + }); + expect(before).toHaveLength(1); + + await page.getByTestId('offline-clear').click(); + await expect(page.getByRole('alertdialog').or(page.getByRole('dialog'))).toContainText('Clear this account on this device?'); + await page.getByRole('button', { name: 'Clear', exact: true }).click(); + // A new key and file, and the mail comes back by itself, with the window kept. + await expect(async () => { + const after = await page.evaluate(async () => { + const db = await new Promise((resolve, reject) => { const r = indexedDB.open('bulwark-store'); r.onsuccess = () => resolve(r.result); r.onerror = () => reject(r.error); }); + const all = await new Promise>((resolve) => { const r = db.transaction('accounts').objectStore('accounts').getAll(); r.onsuccess = () => resolve(r.result); }); + db.close(); + return all.map((record) => record.file); + }); + expect(after).toHaveLength(1); + expect(after).not.toEqual(before); + }).toPass({ timeout: 60_000 }); + await expect.poll(() => keptMessages(page), { timeout: 180_000, intervals: [2000] }).toBeGreaterThan(0); + await expect(select).toHaveValue('365'); + await page.context().close(); +}); + +test('the storage page fits at 390 px', async ({ browser }) => { + const phone = await userPage(browser, ENT.alice, true); + await enableOffline(phone, true); + const overflow = await phone.evaluate(() => document.documentElement.scrollWidth - document.documentElement.clientWidth); + expect(overflow).toBeLessThanOrEqual(0); + await shot(phone, 'do-storage-page-390'); + await phone.context().close(); +}); + +test('a store the browser deleted is noticed, says what was lost and syncs again', async ({ browser }) => { + const subject = `After the eviction ${RUN}`; + await deliverAndWait(subject, `Body ${RUN}`); + const page = await userPage(browser, ENT.alice); + await enableOffline(page); + + // No app on this page, so no worker holds the files, as after closing the tab. + await page.goto('/manifest.webmanifest'); + await expect.poll(() => page.evaluate(async () => { + const root = await navigator.storage.getDirectory(); + const raw = localStorage.getItem('bulwark-offline-health'); + const health = JSON.parse(raw ?? '{}') as Record; + for (const entry of Object.values(health)) entry.pending = 2; + localStorage.setItem('bulwark-offline-health', JSON.stringify(health)); + return root.removeEntry('.bulwark-store', { recursive: true }).then(() => 'gone', (error: Error) => error.name); + }), { timeout: 30_000 }).toBe('gone'); + + await page.goto('/settings/backup/offline'); + await expect(page.getByTestId('offline-evicted')).toContainText('The browser deleted the mail kept on this device', { timeout: 60_000 }); + await expect(page.getByTestId('offline-evicted')).toContainText('2 unsent messages or changes were lost'); + await expect.poll(() => keptMessages(page), { timeout: 180_000, intervals: [2000] }).toBeGreaterThan(0); + await page.getByTestId('offline-evicted').getByRole('button', { name: 'OK' }).click(); + await expect(page.getByTestId('offline-evicted')).toHaveCount(0); + + // The key gone and the file still there: nobody can read it, so it goes too. + await page.goto('/manifest.webmanifest'); + await page.evaluate(() => new Promise((resolve, reject) => { + const r = indexedDB.open('bulwark-store'); + r.onerror = () => reject(r.error); + r.onsuccess = () => { + const tx = r.result.transaction('accounts', 'readwrite'); + tx.objectStore('accounts').clear(); + tx.oncomplete = () => { r.result.close(); resolve(); }; + }; + })); + await page.goto('/settings/backup/offline'); + await expect(page.getByTestId('offline-evicted')).toBeVisible({ timeout: 60_000 }); + await expect.poll(() => keptMessages(page), { timeout: 180_000, intervals: [2000] }).toBeGreaterThan(0); + await page.context().close(); +}); + +test('a browser that refuses to keep the data gets a warning and can be asked again', async ({ browser }) => { + const page = await userPage(browser, ENT.alice); + await page.context().addInitScript(() => { + const answer = () => Promise.resolve(Boolean((window as unknown as { __grant?: boolean }).__grant)); + StorageManager.prototype.persist = answer; + StorageManager.prototype.persisted = answer; + }); + await enableOffline(page); + await expect(page.getByTestId('offline-persist-refused')).toContainText('This browser may delete the kept mail'); + await page.evaluate(() => { (window as unknown as { __grant?: boolean }).__grant = true; }); + await page.getByTestId('offline-persist-retry').click(); + await expect(page.getByTestId('offline-persist-refused')).toHaveCount(0); + await page.context().close(); +}); + +test('nothing of a kept message is readable on the device', async ({ browser }) => { + const subject = `Rawcheck ${RUN} ${RUN}quokka`; + const text = `Rawbody ${RUN} ${RUN}wombat`; + await deliverAndWait(subject, text); + const page = await userPage(browser, ENT.alice); + await toMail(page); + await openMessage(page, subject); + + /** Everything this origin has stored, as raw bytes where it's a file, looked through for a term. */ + const findIn = (term: string) => page.evaluate(async (needle) => { + const hits: string[] = []; + const encoded = new TextEncoder().encode(needle); + const has = (bytes: Uint8Array) => { + outer: for (let i = 0; i <= bytes.length - encoded.length; i += 1) { + for (let j = 0; j < encoded.length; j += 1) if (bytes[i + j] !== encoded[j]) continue outer; + return true; + } + return false; + }; + let files = 0; + let bytesRead = 0; + const walk = async (dir: FileSystemDirectoryHandle, path: string) => { + for await (const [name, handle] of (dir as unknown as { entries(): AsyncIterable<[string, FileSystemHandle]> }).entries()) { + if (handle.kind === 'directory') { await walk(handle as FileSystemDirectoryHandle, `${path}/${name}`); continue; } + // Works while the worker holds the handles. + const bytes = new Uint8Array(await (await (handle as FileSystemFileHandle).getFile()).arrayBuffer()); + files += 1; + bytesRead += bytes.length; + if (has(bytes)) hits.push(`opfs:${path}/${name}`); + } + }; + await walk(await navigator.storage.getDirectory(), ''); + + const flatten = (value: unknown): string => { + if (value instanceof ArrayBuffer) return new TextDecoder('latin1').decode(value); + if (ArrayBuffer.isView(value)) return new TextDecoder('latin1').decode(value as Uint8Array); + if (typeof value === 'string') return value; + if (Array.isArray(value)) return value.map(flatten).join(' '); + if (value && typeof value === 'object' && !(value instanceof CryptoKey)) return Object.entries(value).map(([key, inner]) => `${key} ${flatten(inner)}`).join(' '); + return String(value); + }; + for (const info of await indexedDB.databases()) { + if (!info.name) continue; + const db = await new Promise((resolve, reject) => { const r = indexedDB.open(info.name!); r.onsuccess = () => resolve(r.result); r.onerror = () => reject(r.error); }); + for (const store of db.objectStoreNames) { + const rows = await new Promise((resolve) => { const r = db.transaction(store).objectStore(store).getAll(); r.onsuccess = () => resolve(r.result); r.onerror = () => resolve([]); }); + if (flatten(rows).includes(needle)) hits.push(`indexeddb:${info.name}/${store}`); + } + db.close(); + } + for (const [label, storage] of [['localStorage', localStorage], ['sessionStorage', sessionStorage]] as const) { + for (let i = 0; i < storage.length; i += 1) { + const key = storage.key(i)!; + if (`${key} ${storage.getItem(key)}`.includes(needle)) hits.push(`${label}:${key}`); + } + } + for (const name of await caches.keys()) { + const cache = await caches.open(name); + for (const request of await cache.keys()) { + const response = await cache.match(request); + if (response && (await response.clone().text()).includes(needle)) hits.push(`cache:${name}:${request.url}`); + } + } + return { hits, files, bytesRead }; + }, term); + + // The check can see plaintext: without the store, the boot snapshot has the subject. + await expect.poll(async () => (await findIn(subject)).hits, { timeout: 15_000 }).toContain('localStorage:email-snapshot'); + + await enableOffline(page); + await expect(async () => { + const client = await jmapAs(ENT.alice); + const total = await client.request([['Email/query', { accountId: client.accountId, calculateTotal: true, limit: 0 }, '0']]); + expect(await keptMessages(page)).toBeGreaterThanOrEqual(total.methodResponses[0][1].total); + }).toPass({ timeout: 180_000, intervals: [2000] }); + await toMail(page); + await openMessage(page, subject); + await expect(body(page)).toContainText(text, { timeout: 20_000 }); + await page.waitForTimeout(1500); + + for (const term of [subject, text, `${RUN}quokka`, `${RUN}wombat`]) { + const { hits, files, bytesRead } = await findIn(term); + expect(files, 'the store has its files').toBeGreaterThan(0); + expect(bytesRead, 'and they hold something').toBeGreaterThan(100_000); + expect(hits, `plaintext "${term}"`).toEqual([]); + } + await page.reload(); + await expect(page.locator('[data-testid="email-list-item"]', { hasText: subject }).first()).toBeVisible({ timeout: 60_000 }); + await page.waitForTimeout(1500); + expect((await findIn(subject)).hits).toEqual([]); + await page.context().close(); +}); + +test('the admin page saves the caps and no longer promises 30 days or 250 MB', async ({ browser }) => { + const admin = await adminContext(browser); + const page = await admin.newPage(); + await page.goto('/admin/org-devices'); + const days = page.getByTestId('org-devices-offlineMaxDays'); + await expect(days).toBeVisible({ timeout: 60_000 }); + await expect(page.locator('body')).not.toContainText('250 MB'); + await days.fill('45'); + await page.getByTestId('org-devices-noOfflineAttachments').click(); + await page.getByRole('button', { name: 'Save', exact: true }).first().click(); + await expect.poll(async () => ((await getPolicy(admin)).organisation as { devices?: { offlineMaxDays?: number; noOfflineAttachments?: boolean } }).devices, { timeout: 15_000 }) + .toMatchObject({ offlineMaxDays: 45, noOfflineAttachments: true }); + await shot(page, 'do-admin-offline-caps'); + await putPolicy(admin, { ...original, scopes: [] }); + await admin.close(); +}); + test('a deploy makes the open tab offer a reload and serves no stale chunks', async ({ browser }) => { const redeploy = process.env.IT_OFFLINE_REDEPLOY; test.skip(!redeploy, 'set IT_OFFLINE_REDEPLOY to the command that deploys a second build (enterprise-rig/scratch/f-redeploy.sh)'); From fb40944c2d3a06bf15259843e955deec1a59ed08 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 09:28:31 +0100 Subject: [PATCH 13/20] feat: hold kept files to the scope at once, and count them towards what each account takes --- lib/store/__tests__/files.test.ts | 69 +++++++++++++++++++++++++++ lib/store/__tests__/mail-sync.test.ts | 2 +- lib/store/contacts/index.ts | 4 ++ lib/store/files/index.ts | 5 +- lib/store/files/keep.ts | 46 +++++++++++++++++- 5 files changed, 123 insertions(+), 3 deletions(-) diff --git a/lib/store/__tests__/files.test.ts b/lib/store/__tests__/files.test.ts index acf81b483..41d158e12 100644 --- a/lib/store/__tests__/files.test.ts +++ b/lib/store/__tests__/files.test.ts @@ -311,6 +311,75 @@ describe('pinned files', () => { expect(status.files.filter((f: { error: string | null }) => f.error === 'overLimit')).toHaveLength(1); }); + describe('a tightened scope, with no network', () => { + async function keptOffline(rig: Rig) { + rig.engine.setOnline(false); + } + + it('drops everything kept when files are forbidden, and the pins stay', async () => { + const server = new FakeFiles(); + const file = server.addFile('a', null, 60); + const rig = await synced(server); + await rig.engine.areaCall('files.pin', ref(file.id)); + await rig.engine.requestSync(); + await keptOffline(rig); + rig.engine.setScope({ ...DEFAULT_SCOPE, attachments: false }); + await rig.engine.requestSync(); + expect(await rig.engine.areaCall('files.read', ref(file.id))).toBeNull(); + expect((await rig.engine.areaCall('files.kept', undefined) as any).files[0]).toMatchObject({ pinned: true, kept: false, error: 'notAllowed' }); + }); + + it('drops an opened file over the new size, not a pinned one', async () => { + const server = new FakeFiles(); + const pinned = server.addFile('pinned', null, 60); + const opened = server.addFile('opened', null, 60); + const rig = await synced(server); + await rig.engine.areaCall('files.pin', ref(pinned.id)); + await rig.engine.areaCall('files.noteOpened', ref(opened.id)); + await rig.engine.requestSync(); + await keptOffline(rig); + rig.engine.setScope({ ...DEFAULT_SCOPE, maxAttachmentBytes: 10 }); + await rig.engine.requestSync(); + expect(await rig.engine.areaCall('files.read', ref(opened.id))).toBeNull(); + expect(await rig.engine.areaCall('files.read', ref(pinned.id))).not.toBeNull(); + }); + + it('holds even pins to a lower total, newest out first, and doesn\'t fetch them back', async () => { + const server = new FakeFiles(); + const older = server.addFile('older', null, 60); + const newer = server.addFile('newer', null, 60); + const rig = await synced(server); + await rig.engine.areaCall('files.pin', ref(older.id)); + await rig.engine.requestSync(); + rig.clock.at += 1000; + await rig.engine.areaCall('files.pin', ref(newer.id)); + await rig.engine.requestSync(); + await keptOffline(rig); + rig.engine.setScope({ ...DEFAULT_SCOPE, maxTotalBytes: 100 }); + await rig.engine.requestSync(); + expect(await rig.engine.areaCall('files.read', ref(older.id))).not.toBeNull(); + expect(await rig.engine.areaCall('files.read', ref(newer.id))).toBeNull(); + const status = (await rig.engine.areaCall('files.kept', undefined) as any).files; + expect(status.find((f: { id: string }) => f.id === newer.id).error).toBe('overLimit'); + + server.downloads.length = 0; + rig.engine.setOnline(true); + await rig.engine.requestSync(); + expect(server.downloads).toEqual([]); + }); + }); + + it('counts towards the storage page, and takes its part of the total from mail', async () => { + const server = new FakeFiles(); + const file = server.addFile('a', null, 60); + const rig = await synced(server); + await rig.engine.areaCall('files.pin', ref(file.id)); + await rig.engine.requestSync(); + const usage = await rig.engine.areaCall('store.usage', undefined) as { parts: Array<{ part: string; bytes: number; items: number }> }; + expect(usage.parts).toContainEqual({ part: 'files', bytes: 60, items: 1 }); + expect(filesArea.keptBytes?.({ db: rig.db })).toBe(60); + }); + it('keeps nothing when the scope forbids it, and drops what was kept', async () => { const server = new FakeFiles(); const file = server.addFile('a'); diff --git a/lib/store/__tests__/mail-sync.test.ts b/lib/store/__tests__/mail-sync.test.ts index e4424a4a3..4d7b61185 100644 --- a/lib/store/__tests__/mail-sync.test.ts +++ b/lib/store/__tests__/mail-sync.test.ts @@ -443,7 +443,7 @@ describe('query plans', () => { }, }; const answer = await answerRequest( - { account: 'a', db: spied as typeof db, session: FAKE_SESSION, scope: EVERYTHING, now: Date.now, emit: () => {}, overlay: (_jmap, _type, records) => records, keptByOthers: () => 0, defaultJmap: JMAP_ACCOUNT, invertedKeywordSort: false }, + { account: 'a', db: spied as typeof db, session: FAKE_SESSION, scope: EVERYTHING, now: Date.now, emit: () => {}, overlay: (_jmap, _type, records) => records, keptByOthers: () => 0, requestSync: async () => {}, defaultJmap: JMAP_ACCOUNT, invertedKeywordSort: false }, buildMethodTable([mailArea]), [['Email/query', { filter: INBOX, sort: [{ property: 'receivedAt', isAscending: false }], limit: 5 }, 'q']], ); diff --git a/lib/store/contacts/index.ts b/lib/store/contacts/index.ts index 01b129a8a..8c964775f 100644 --- a/lib/store/contacts/index.ts +++ b/lib/store/contacts/index.ts @@ -9,6 +9,10 @@ export const contactsArea: StoreArea = { migrations: CONTACT_MIGRATIONS, methods: CONTACT_METHODS, syncers: [contactsSyncer], + usage: (ctx) => { + const row = ctx.db.get<{ bytes: number | null; items: number }>('SELECT SUM(LENGTH(json)) AS bytes, COUNT(*) AS items FROM contact_card'); + return [{ part: 'contacts', bytes: Number(row?.bytes ?? 0), items: Number(row?.items ?? 0) }]; + }, calls: { /** Sends what's queued, in the next sync pass, and says what's left. */ 'contacts.flush': async (ctx) => { diff --git a/lib/store/files/index.ts b/lib/store/files/index.ts index 0957ced89..016d4b4f6 100644 --- a/lib/store/files/index.ts +++ b/lib/store/files/index.ts @@ -1,5 +1,5 @@ import type { StoreArea } from '../area'; -import { fileBlob, keptStatus, noteOpened, pinFile, readFile, unpinFile, type NodeRef } from './keep'; +import { applyFilesScope, fileBlob, filesUsage, keptStatus, noteOpened, pinFile, readFile, unpinFile, type NodeRef } from './keep'; import { FILE_METHODS } from './methods'; import { FILE_MIGRATIONS } from './schema'; import { filesSyncer } from './sync'; @@ -11,6 +11,9 @@ export const filesArea: StoreArea = { migrations: FILE_MIGRATIONS, methods: FILE_METHODS, syncers: [filesSyncer], + applyScope: applyFilesScope, + usage: filesUsage, + keptBytes: (ctx) => filesUsage(ctx)[0].bytes, calls: { /** Keep this file's content on the device until it's unpinned. */ 'files.pin': (ctx, params: NodeRef) => pinFile(ctx, params), diff --git a/lib/store/files/keep.ts b/lib/store/files/keep.ts index a11b93455..919d7cb97 100644 --- a/lib/store/files/keep.ts +++ b/lib/store/files/keep.ts @@ -13,7 +13,7 @@ */ import { TransportError } from '../engine/transport'; -import { MethodError, type StoreContext, type SyncContext } from '../area'; +import { MethodError, type ScopeChange, type StoreContext, type StoreUsagePart, type SyncContext } from '../area'; import type { StorageAdapter } from '../storage'; import { nodeMediaType, type WireNode } from './records'; @@ -220,6 +220,50 @@ export async function fetchKeptFiles(ctx: SyncContext, jmap: string): Promise 0) ctx.emit({ type: 'changed', account: ctx.account, collections: ['FileContent'] }); } +/** + * What the scope no longer allows leaves now, without the network. The pins + * stay, so a loosened scope fetches them back at the next pass. A pin ignores + * the size limit but not the total: the organisation's cap wins over it. + */ +export function applyFilesScope(ctx: SyncContext, _change: ScopeChange): void { + const { db, scope } = ctx; + let changed = false; + db.transaction(() => { + if (!scope.attachments) { + for (const blob of keptBlobs(db)) { + dropBlob(db, blob.jmap, blob.blob_id); + changed = true; + } + db.run("UPDATE file_node SET keep_error = 'notAllowed' WHERE pinned = 1 OR opened_at IS NOT NULL"); + return; + } + const largest = Math.min(scope.maxAttachmentBytes, capBytes(ctx)); + for (const blob of keptBlobs(db)) { + if (blob.pinned || Number(blob.size) <= largest) continue; + pushOut(db, blob); + changed = true; + } + const before = keptBlobs(db).length; + makeRoom(ctx, 0, { pinned: true, openedAt: 0 }); + if (keptBlobs(db).length !== before) changed = true; + // Past the total with pins alone: the newest kept go first, as they would have been refused. + let pinned = pinnedBytes(db); + for (const blob of keptBlobs(db).filter((row) => row.pinned).sort((a, b) => Number(b.kept_at) - Number(a.kept_at))) { + if (pinned <= scope.maxTotalBytes) break; + pinned -= Number(blob.size); + dropBlob(db, blob.jmap, blob.blob_id); + setError(db, blob.jmap, blob.blob_id, 'overLimit'); + changed = true; + } + }); + if (changed) ctx.emit({ type: 'changed', account: ctx.account, collections: ['FileContent'] }); +} + +export function filesUsage(ctx: Pick): StoreUsagePart[] { + const row = ctx.db.get<{ bytes: number | null; items: number }>('SELECT SUM(size) AS bytes, COUNT(*) AS items FROM file_blob'); + return [{ part: 'files', bytes: Number(row?.bytes ?? 0), items: Number(row?.items ?? 0) }]; +} + // ---- Calls from the page ---- function fileRow(db: StorageAdapter, { jmap, id }: NodeRef): NodeRow { From 87b15b12f6c3258cba3bdaec2bc5458ffba82bf3 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 09:28:31 +0100 Subject: [PATCH 14/20] test: check Keep offline in the Files app --- integration/tests/22-ent-offline.spec.ts | 36 ++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/integration/tests/22-ent-offline.spec.ts b/integration/tests/22-ent-offline.spec.ts index 694c02931..5e2b6e642 100644 --- a/integration/tests/22-ent-offline.spec.ts +++ b/integration/tests/22-ent-offline.spec.ts @@ -863,6 +863,42 @@ test('nothing of a kept message is readable on the device', async ({ browser }) await page.context().close(); }); +test('Keep offline in the Files app keeps the file, and the settings list it', async ({ browser }) => { + const name = `kept-${RUN}.txt`; + const client = await jmapAs(ENT.alice); + const auth = 'Basic ' + Buffer.from(`${ENT.alice}:${process.env.IT_ENT_PASSWORD}`).toString('base64'); + const upload = await fetch(`${JMAP_URL}/jmap/upload/${client.accountId}/`, { method: 'POST', headers: { Authorization: auth, 'Content-Type': 'text/plain' }, body: `Kept file ${RUN}` }); + expect(upload.ok).toBe(true); + const { blobId } = await upload.json() as { blobId: string }; + const made = await client.request([['FileNode/set', { accountId: client.accountId, create: { f: { name, blobId, parentId: null, type: 'text/plain' } } }, '0']], ['urn:ietf:params:jmap:core', 'urn:ietf:params:jmap:filenode']); + const created = made.methodResponses[0][1].created?.f as { id: string } | undefined; + expect(created, JSON.stringify(made.methodResponses[0][1])).toBeTruthy(); + try { + const page = await userPage(browser, ENT.alice); + await enableOffline(page); + await page.goto('/files'); + const row = page.getByText(name, { exact: true }).first(); + await expect(row).toBeVisible({ timeout: 60_000 }); + await row.click({ button: 'right' }); + await page.getByRole('menuitem', { name: 'Keep offline' }).click(); + await page.goto('/settings/backup/offline'); + await expect(page.getByTestId('offline-kept-file').filter({ hasText: name })).toHaveAttribute('data-kept', 'true', { timeout: 120_000 }); + await page.getByTestId('offline-kept-files').scrollIntoViewIfNeeded(); + await shot(page, 'do-storage-page-kept-files'); + + await page.goto('/files'); + await expect(row).toBeVisible({ timeout: 60_000 }); + await row.click({ button: 'right' }); + await page.getByRole('menuitem', { name: 'Stop keeping offline' }).click(); + await page.goto('/settings/backup/offline'); + await expect(page.getByTestId('offline-account')).toBeVisible({ timeout: 60_000 }); + await expect(page.getByTestId('offline-kept-file').filter({ hasText: name })).toHaveCount(0, { timeout: 30_000 }); + await page.context().close(); + } finally { + await client.request([['FileNode/set', { accountId: client.accountId, destroy: [created!.id] }, '0']], ['urn:ietf:params:jmap:core', 'urn:ietf:params:jmap:filenode']).catch(() => {}); + } +}); + test('the admin page saves the caps and no longer promises 30 days or 250 MB', async ({ browser }) => { const admin = await adminContext(browser); const page = await admin.newPage(); From 1dde70399308a66d6467df17bfcd53363f5125c5 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 09:53:04 +0100 Subject: [PATCH 15/20] fix: list files again when the real client takes over from the local copy --- integration/tests/22-ent-offline.spec.ts | 4 +++- stores/__tests__/file-store.test.ts | 20 +++++++++++++++++++- stores/file-store.ts | 6 ++++++ 3 files changed, 28 insertions(+), 2 deletions(-) diff --git a/integration/tests/22-ent-offline.spec.ts b/integration/tests/22-ent-offline.spec.ts index 5e2b6e642..e9f684b81 100644 --- a/integration/tests/22-ent-offline.spec.ts +++ b/integration/tests/22-ent-offline.spec.ts @@ -842,7 +842,9 @@ test('nothing of a kept message is readable on the device', async ({ browser }) await enableOffline(page); await expect(async () => { const client = await jmapAs(ENT.alice); - const total = await client.request([['Email/query', { accountId: client.accountId, calculateTotal: true, limit: 0 }, '0']]); + // The default window: the old message of the cap test stays out. + const after = new Date(Date.now() - 90 * 86_400_000).toISOString().replace(/\.\d+Z$/, 'Z'); + const total = await client.request([['Email/query', { accountId: client.accountId, filter: { after }, calculateTotal: true, limit: 0 }, '0']]); expect(await keptMessages(page)).toBeGreaterThanOrEqual(total.methodResponses[0][1].total); }).toPass({ timeout: 180_000, intervals: [2000] }); await toMail(page); diff --git a/stores/__tests__/file-store.test.ts b/stores/__tests__/file-store.test.ts index bf7080b02..74dbad63c 100644 --- a/stores/__tests__/file-store.test.ts +++ b/stores/__tests__/file-store.test.ts @@ -1,4 +1,4 @@ -import { describe, it, expect, beforeEach } from 'vitest'; +import { describe, it, expect, beforeEach, vi } from 'vitest'; import { useFileStore, linkedPreviewResource, resourceServerRef, sharedFilesLocation } from '../file-store'; import type { IJMAPClient } from '@/lib/jmap/client-interface'; import type { FileNode } from '@/lib/jmap/types'; @@ -106,6 +106,24 @@ const file = (id: string, name: string, parentId: string | null): FileNode => ({ id, parentId, name, type: 'text/plain', blobId: `b-${id}`, size: 10, created: '', modified: '', }); +describe('after a start from the local copy', () => { + it('lists again when the real client takes over, and the error of asking the device goes', async () => { + const local = makeMockClient([]); + (local as unknown as { isOfflineOnly: () => boolean }).isOfflineOnly = () => true; + local.listAllFileNodes = async () => { throw new Error('Not available offline'); }; + useFileStore.setState({ client: null, supportsFiles: null, resources: [], error: null, currentParentId: null, pathStack: [{ id: null, name: '' }] } as never); + useFileStore.getState().initClient(local as unknown as IJMAPClient, 'acc'); + useFileStore.setState({ supportsFiles: true }); + await useFileStore.getState().navigate(null); + expect(useFileStore.getState().error).toBeTruthy(); + + const real = makeMockClient([{ id: 'f1', parentId: null, name: 'kept.txt', type: 'text/plain', blobId: 'b', size: 1, created: '', modified: '' }]); + useFileStore.getState().initClient(real as unknown as IJMAPClient, 'acc'); + await vi.waitFor(() => expect(useFileStore.getState().resources.map((r) => r.name)).toEqual(['kept.txt'])); + expect(useFileStore.getState().error).toBeFalsy(); + }); +}); + describe('file-store hierarchy (issue #379)', () => { beforeEach(() => { useFileStore.setState({ diff --git a/stores/file-store.ts b/stores/file-store.ts index 328635142..fcee224eb 100644 --- a/stores/file-store.ts +++ b/stores/file-store.ts @@ -649,9 +649,15 @@ export const useFileStore = create((set, get) => ({ })(), initClient: (client: IJMAPClient, accountId?: string | null) => { + const before = get().client as (IJMAPClient & { isOfflineOnly?: () => boolean }) | null; const patch: Partial = { client }; if (accountId !== undefined) patch.currentAccountId = accountId; set(patch); + // A start from the local copy: the real client just took over, and what's + // listed is what the device had, or the error of asking it. + const offlineBefore = before !== client && before?.isOfflineOnly?.(); + const offlineNow = (client as IJMAPClient & { isOfflineOnly?: () => boolean }).isOfflineOnly?.(); + if (offlineBefore && !offlineNow && get().supportsFiles) void get().refresh(); }, clearClient: () => { From e8696094e44ef15033c0a774d82ab4338921c03f Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 10:05:43 +0100 Subject: [PATCH 16/20] fix: open an account again in the owner tab after another tab cleared it --- .../__tests__/effective-scope-wiring.test.ts | 18 +++++++++++++++++- lib/offline/offline-mode.ts | 10 +++++++++- lib/store/__tests__/host.test.ts | 12 ++++++++++++ lib/store/__tests__/page-side.test.ts | 16 ++++++++++++++++ lib/store/area.ts | 4 +++- lib/store/client/api.ts | 2 ++ lib/store/worker/host.ts | 4 +++- 7 files changed, 62 insertions(+), 4 deletions(-) diff --git a/lib/offline/__tests__/effective-scope-wiring.test.ts b/lib/offline/__tests__/effective-scope-wiring.test.ts index d960f0d58..c454a8570 100644 --- a/lib/offline/__tests__/effective-scope-wiring.test.ts +++ b/lib/offline/__tests__/effective-scope-wiring.test.ts @@ -17,10 +17,11 @@ import { registerOfflineHooks, scopeForAccount, setOfflineNotifier, + startOfflineMode, wipeEverything, type OfflineNotice, } from '../offline-mode'; -import { useOfflineStore, writeEnabled } from '../state'; +import { OFFLINE_HEALTH_KEY, useOfflineStore, writeEnabled, writeHealth } from '../state'; const NOW = Date.now(); const iso = (daysAgo: number) => new Date(NOW - daysAgo * 86_400_000).toISOString(); @@ -155,6 +156,21 @@ describe('clearing an account', () => { }); }); +describe('clearing in another tab', () => { + it('opens the new store here, in case this tab owns it', async () => { + writeEnabled(['acc']); + writeHealth('acc', { opened: true }); + const stop = startOfflineMode(); + const ensureOpen = vi.spyOn(store, 'ensureOpen'); + ensureOpen.mockClear(); + localStorage.setItem(OFFLINE_HEALTH_KEY, JSON.stringify({ acc: { opened: false, pending: 0 } })); + window.dispatchEvent(new StorageEvent('storage', { key: OFFLINE_HEALTH_KEY })); + expect(ensureOpen).toHaveBeenCalledWith('acc'); + expect(useOfflineStore.getState().health.acc.opened).toBe(false); + stop(); + }); +}); + describe('the desktop app', () => { const asDesktop = () => { (window as { bulwarkDesktop?: unknown }).bulwarkDesktop = { version: 1 }; }; diff --git a/lib/offline/offline-mode.ts b/lib/offline/offline-mode.ts index 9ccda7694..cc6b0c945 100644 --- a/lib/offline/offline-mode.ts +++ b/lib/offline/offline-mode.ts @@ -1066,7 +1066,15 @@ export function startOfflineMode(): () => void { // switched on there has to be opened here if this tab owns the store. const onStorage = (event: StorageEvent) => { if (event.key === OFFLINE_CHOICES_KEY || event.key === null) useOfflineStore.setState({ choices: readStoredChoices() }); - if (event.key === OFFLINE_HEALTH_KEY || event.key === null) useOfflineStore.setState({ health: readStoredHealth() }); + if (event.key === OFFLINE_HEALTH_KEY || event.key === null) { + const before = useOfflineStore.getState().health; + const health = readStoredHealth(); + useOfflineStore.setState({ health }); + // Another tab cleared an account that stays on: if this tab owns the store, it opens the new one. + for (const id of useOfflineStore.getState().enabled) { + if (before[id]?.opened && health[id]?.opened === false) void getStore().ensureOpen(id).catch(() => {}); + } + } if (event.key !== OFFLINE_ACCOUNTS_KEY && event.key !== null) return; const next = readEnabledFrom(event.key === null ? null : event.newValue); const before = useOfflineStore.getState().enabled; diff --git a/lib/store/__tests__/host.test.ts b/lib/store/__tests__/host.test.ts index cff241a70..d4d27d46d 100644 --- a/lib/store/__tests__/host.test.ts +++ b/lib/store/__tests__/host.test.ts @@ -98,6 +98,18 @@ describe('files with no key', () => { }); }); +describe('removing an account', () => { + it('tells every tab, once the file is gone', async () => { + const storage = new FakeStorage(); + const events: unknown[] = []; + const running = new StoreHost({ areas: [mailArea], storage, emit: (event) => events.push({ event, file: storage.files().length }), needAuth: () => {} }); + await running.openAccount(params('/a1.db')); + events.length = 0; + await running.removeAccount('a', '/a1.db'); + expect(events).toContainEqual({ event: { type: 'removed', account: 'a' }, file: 0 }); + }); +}); + describe('a scope from another tab', () => { it('reaches the engine over the channel call', async () => { const storage = new FakeStorage(); diff --git a/lib/store/__tests__/page-side.test.ts b/lib/store/__tests__/page-side.test.ts index 045919141..c8efd1642 100644 --- a/lib/store/__tests__/page-side.test.ts +++ b/lib/store/__tests__/page-side.test.ts @@ -250,6 +250,22 @@ describe('the page\'s store', () => { store.stop(); }); + it('opens an account again once another tab removed it', async () => { + allowEngine(); + const store = getStore(); + await store.ensureOpen('a@x'); + const worker = FakeWorker.all[0]; + worker.becomeOwner(); + await vi.waitFor(() => expect(worker.posted.filter((m) => m.kind === 'open')).toHaveLength(1)); + await store.ensureOpen('a@x'); + expect(worker.posted.filter((m) => m.kind === 'open')).toHaveLength(1); + + worker.onmessage?.({ data: { kind: 'event', event: { type: 'removed', account: 'a@x' } } } as MessageEvent); + await store.ensureOpen('a@x'); + await vi.waitFor(() => expect(worker.posted.filter((m) => m.kind === 'open')).toHaveLength(2)); + store.stop(); + }); + it('stops waiting when the engine couldn\'t start in this browser', async () => { allowEngine(); const store = getStore(); diff --git a/lib/store/area.ts b/lib/store/area.ts index dcb4340d6..e5440d74b 100644 --- a/lib/store/area.ts +++ b/lib/store/area.ts @@ -67,7 +67,9 @@ export type StoreEvent = | { type: 'synced'; account: string; at: number } | { type: 'changed'; account: string; collections: string[] } | { type: 'created'; account: string; jmap: string; collection: string; ids: string[] } - | { type: 'error'; account: string; area: string; message: string }; + | { type: 'error'; account: string; area: string; message: string } + /** Its file and key are gone, whichever tab asked: opening it again makes a new one. */ + | { type: 'removed'; account: string }; export interface StoreContext { account: string; diff --git a/lib/store/client/api.ts b/lib/store/client/api.ts index d2b1f5532..7d4731871 100644 --- a/lib/store/client/api.ts +++ b/lib/store/client/api.ts @@ -75,6 +75,8 @@ class PageStore implements StoreBackend { buildId: process.env.NEXT_PUBLIC_BUILD_ID, onEvent: (event) => { if (event.type === 'error' && event.area === 'store' && !event.account) this.broken = true; + // Another tab cleared it: what this tab remembers opening is gone. + if (event.type === 'removed') this.opening.delete(event.account); this.hooks()?.onEvent(event); }, onOwner: () => { diff --git a/lib/store/worker/host.ts b/lib/store/worker/host.ts index 0620d05b3..14002de2b 100644 --- a/lib/store/worker/host.ts +++ b/lib/store/worker/host.ts @@ -155,7 +155,9 @@ export class StoreHost { async removeAccount(account: string, file: string): Promise { await this.closeAccount(account); this.synced.delete(account); - return this.options.storage.remove(file); + const removed = this.options.storage.remove(file); + this.options.emit({ type: 'removed', account }); + return removed; } async closeAll(): Promise { From 84c73ab15a0938681001bf896f5d4786c17f8227 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 10:19:28 +0100 Subject: [PATCH 17/20] test: let the store's own sync finish before failing the outbox lookup With contacts and files in the store a pass runs longer, and the failure meant for the lookup could go to the sync's own Email/query. --- lib/offline/__tests__/outbox.test.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/offline/__tests__/outbox.test.ts b/lib/offline/__tests__/outbox.test.ts index 03e61e04b..f89c609e4 100644 --- a/lib/offline/__tests__/outbox.test.ts +++ b/lib/offline/__tests__/outbox.test.ts @@ -334,6 +334,8 @@ describe('a send whose response got lost', () => { it('a lookup that can\'t decide leaves it uncertain for the user, who can still send it', async () => { const client = fakeClient(); const entry = await uncertainSend(client); + // The store's own sync mustn't take the failure meant for the lookup. + await store.sync('acc'); server.failNext.set('Email/query', 'forbidden'); await flush(client); expect(client.sendEmail).not.toHaveBeenCalled(); From 4044351611fc3f7652b788dd03e12ccaa7daa71a Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 10:51:36 +0100 Subject: [PATCH 18/20] test: keep what was chosen for a store that waits for a new sign-in --- lib/__tests__/sign-out-cleanup.test.ts | 2 +- lib/offline/__tests__/storage-health.test.ts | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/lib/__tests__/sign-out-cleanup.test.ts b/lib/__tests__/sign-out-cleanup.test.ts index 005865d76..e0071adfb 100644 --- a/lib/__tests__/sign-out-cleanup.test.ts +++ b/lib/__tests__/sign-out-cleanup.test.ts @@ -26,7 +26,7 @@ describe('purgeSignedOutData', () => { for (const key of [ 'email-snapshot', 'pro-tabs', 'search-history-storage', 'calendar-storage', 'files-favorites', 'files-recent-files', 'files-path-stack', 'bulwark-delegate-names', - 'bulwark-offline-accounts', 'bulwark-offline-choices', 'bulwark-offline-health', + 'bulwark-offline-accounts', 'bulwark-offline-scope', 'bulwark-offline-health', 'settings-storage', 'theme-storage', 'locale-storage', 'template-storage', 'files-view-mode', ]) localStorage.setItem(key, 'x'); diff --git a/lib/offline/__tests__/storage-health.test.ts b/lib/offline/__tests__/storage-health.test.ts index 49400a0f1..064542837 100644 --- a/lib/offline/__tests__/storage-health.test.ts +++ b/lib/offline/__tests__/storage-health.test.ts @@ -313,6 +313,16 @@ describe('removing an account', () => { }); describe('a full sign-out', () => { + it('that keeps the local store for a new sign-in keeps what was chosen for it too', () => { + writeEnabled(['acc']); + writeChoice('acc', { days: 30 }); + writeHealth('acc', { pending: 2 }); + purgeSignedOutData({ keepLocalStore: true }); + expect(JSON.parse(localStorage.getItem(OFFLINE_SCOPE_KEY)!).acc.days).toBe(30); + expect(JSON.parse(localStorage.getItem(OFFLINE_HEALTH_KEY)!).acc.pending).toBe(2); + expect(useOfflineStore.getState().choices.acc.days).toBe(30); + }); + it('deletes the files, every key and what was stored about them', async () => { const removeEntry = vi.fn(async () => {}); setStorage({ getDirectory: async () => ({ removeEntry }) }); From fee9fec0859eadf19d0fa2c12b6bd05d70c75da6 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 11:06:19 +0100 Subject: [PATCH 19/20] fix: say that the store was lost also when it opened before the page could show a notice --- components/offline/offline-host.tsx | 2 +- lib/offline/__tests__/storage-health.test.ts | 13 +++++++++++++ lib/offline/offline-mode.ts | 17 +++++++++++++---- 3 files changed, 27 insertions(+), 5 deletions(-) diff --git a/components/offline/offline-host.tsx b/components/offline/offline-host.tsx index 5e4f7cffd..23208b1d8 100644 --- a/components/offline/offline-host.tsx +++ b/components/offline/offline-host.tsx @@ -119,7 +119,7 @@ export function OfflineHost() { return () => { removeGate(); stop(); - setOfflineNotifier(() => {}); + setOfflineNotifier(null); }; }, []); diff --git a/lib/offline/__tests__/storage-health.test.ts b/lib/offline/__tests__/storage-health.test.ts index 064542837..2a4b99dc2 100644 --- a/lib/offline/__tests__/storage-health.test.ts +++ b/lib/offline/__tests__/storage-health.test.ts @@ -185,6 +185,19 @@ describe('a store the browser cleared', () => { expect(useOfflineStore.getState().health.acc.reset).toBeUndefined(); }); + it('says so also when the store opened before the host component was there', async () => { + setOfflineNotifier(null); + await openAccountKey('acc'); + hadStore('acc'); + FakeWorker.created = true; + const worker = await openAsOwner('acc'); + await vi.waitFor(() => expect(worker.posted.some((m) => m.kind === 'open')).toBe(true)); + await vi.waitFor(() => expect(useOfflineStore.getState().storeLost).toEqual(['acc'])); + expect(notices).toEqual([]); + setOfflineNotifier((notice) => notices.push(notice)); + expect(notices).toContainEqual({ kind: 'store-reset', lost: 0 }); + }); + it('keeps only numbers about it outside the store', () => { writeHealth('acc', { pending: 2, reset: { at: 5, lost: 2 }, lastSync: 9 }); expect(JSON.parse(localStorage.getItem(OFFLINE_HEALTH_KEY)!)).toEqual({ acc: { pending: 2, reset: { at: 5, lost: 2 }, lastSync: 9 } }); diff --git a/lib/offline/offline-mode.ts b/lib/offline/offline-mode.ts index 453b54be8..8966c614b 100644 --- a/lib/offline/offline-mode.ts +++ b/lib/offline/offline-mode.ts @@ -107,11 +107,20 @@ export type OfflineNotice = | { kind: 'forbidden' } | { kind: 'back-online-reload' }; -let notify: (notice: OfflineNotice) => void = () => {}; +/** + * The auth store opens the local store at start, and that can be before the + * host component has mounted: what's said until then waits for it. + */ +const earlyNotices: OfflineNotice[] = []; +const holdNotice = (notice: OfflineNotice) => { + if (earlyNotices.length < 20) earlyNotices.push(notice); +}; +let notify: (notice: OfflineNotice) => void = holdNotice; -/** Where the notices go (the host component turns them into toasts). */ -export function setOfflineNotifier(fn: (notice: OfflineNotice) => void): void { - notify = fn; +/** Where the notices go (the host component turns them into toasts). Null: none is there at the moment. */ +export function setOfflineNotifier(fn: ((notice: OfflineNotice) => void) | null): void { + notify = fn ?? holdNotice; + if (fn) for (const notice of earlyNotices.splice(0)) fn(notice); } export function offlineNotify(notice: OfflineNotice): void { From e215423b5bd794bad4759290b1608f432d75b403 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Tue, 3 Nov 2026 11:24:39 +0100 Subject: [PATCH 20/20] fix: notice a lost store also when the first try to open it had no session yet --- lib/store/__tests__/host.test.ts | 12 ++++++++++++ lib/store/worker/host.ts | 6 ++++++ 2 files changed, 18 insertions(+) diff --git a/lib/store/__tests__/host.test.ts b/lib/store/__tests__/host.test.ts index dfe31861d..e0b9ab49b 100644 --- a/lib/store/__tests__/host.test.ts +++ b/lib/store/__tests__/host.test.ts @@ -39,6 +39,18 @@ const params = (file: string, session: unknown = FAKE_SESSION, account = 'a') => account, file, keyHex: KEY, session, scope: DEFAULT_SCOPE, invertedKeywordSort: null, auth: null, }) as Parameters[0]; +describe('opening an account', () => { + it('says it was created, also after a first try with no session', async () => { + const storage = new FakeStorage(); + await expect(host(storage).openAccount(params('/a1.db', null))).rejects.toThrow('No session'); + expect(storage.files()).toEqual([]); + const running = host(storage); + expect(await running.openAccount(params('/a1.db'))).toEqual({ created: true }); + await running.closeAll(); + expect(await host(storage).openAccount(params('/a1.db', null))).toEqual({ created: false }); + }); +}); + describe('removing an account', () => { it('tells every tab, once the file is gone', async () => { const storage = new FakeStorage(); diff --git a/lib/store/worker/host.ts b/lib/store/worker/host.ts index 1c1d3c035..47f6bb65c 100644 --- a/lib/store/worker/host.ts +++ b/lib/store/worker/host.ts @@ -61,6 +61,12 @@ export class StoreHost { } const db = await this.options.storage.open(params.file, params.keyHex); const created = !db.get("SELECT 1 AS yes FROM sqlite_master WHERE name = 'schema_migration'"); + // Nothing to sync with yet. No file stays behind, or the next open couldn't tell that this one was new. + if (created && !params.session) { + db.close(); + this.options.storage.remove(params.file); + throw new Error('No session for this account yet'); + } const session = params.session ?? AccountEngine.storedSession(db); if (!session) { db.close();