mirror of
https://github.com/Darkrock-Studios/hammer-editor.git
synced 2026-08-04 23:29:46 +00:00
1b312bc3b2
* Add per-project language setting (#754) An optional BCP-47 language on ProjectData, picked from a searchable list of all platform locales in project settings. New projects default to the device locale; the Alice example project is en-US. Spell check is gated per project: when the project language does not leniently match the dictionary locale, the dictionary is withheld (ProjectSpellCheckRepository) and project settings explain why. The public story page emits <html lang> and JSON-LD inLanguage from the declared language, and EPUB export prefers it over the device locale. The hasher contributes zero bytes when unset so existing sync hashes stay stable. * Fix review findings in the project-language feature createProject now only seeds the default language for genuinely new projects (seedDefaultLanguage), so account sync materializes server projects with the never-synced baseline intact, and the seed is language-only so it cannot gate spell check against a same-language dictionary. The hasher's language block gets a -1 marker plus length prefix so it can never collide with a tags block, and the initial write goes through the shared saveStoredProjectData path. The Locale type now retains the script subtag, keeping zh-Hans/zh-Hant style locales distinct in the picker. The picker's clear row is pinned above the list so it survives an empty search, watchSpellCheckAllowed delivers on the main dispatcher, and the public story page hashes the stored project-data hash into its validator instead of parsing the blob per request, applying the language override after withDefaults so chrome links keep the viewer's locale. * Enforce single-owner persisted formats The tags write in PromoteIdeaUseCase rewrote project_data.toml from scratch, erasing the language seed createProject had just written: the exact hazard of a second inline writer. It now read-modify-writes through the datasource's scope-less helpers, and ProjectsListComponent's hand-rolled reader delegates to a new blocking readStoredProjectData. The rule is written down (ARCHITECTURE.md hard constraint 7, CLAUDE.md) and enforced by PersistedFormatOwnershipTest, which fails the build when raw TOML I/O appears outside a Datasource file. Migrators are exempt by role; the two remaining legacy offenders are allowlisted as a burn-down that can only shrink. * Burn down the last raw TOML I/O outside datasources ProjectStatisticsCacheReader now delegates to a scope-less readProjectStatistics helper in StatisticsDatasource, and the example project's fabricated activity log goes through writeDeviceLog in WritingActivityDatasource, which also becomes the single owner of the .activity path convention. With no offenders left, PersistedFormatOwnershipTest drops its burn-down allowlist entirely: only Datasource files and migrators may touch persisted TOML formats from here on. * Pass seedDefaultLanguage in the Android instrumented-test harness * Pass seedDefaultLanguage in the round-trip sync HeadlessClient |
||
|---|---|---|
| .. | ||
| src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration | ||
| build.gradle.kts | ||
| README.md | ||
Sync integration tests
End-to-end sync tests that run the real client sync engine against a real server. Each test
spins up an in-process Jetty server (RoundTripTestBase)
and drives one or more fully-wired clients (HeadlessClient)
through it. Unlike the server-side :server e2e tests, which drive the HTTP API by hand, these
exercise the client's store / hash / conflict logic — the layer where divergence bugs actually live.
The model-free oracle
The hard part of testing sync is knowing the expected end state. We mostly avoid computing it, and
instead assert two properties that any correct sync must satisfy — both on RoundTripTestBase:
assertConverged(projectName, vararg clients)— every client holds exactly the entity set the server holds, hash for hash. Doesn't care what the entities are, only that the sides agree.assertResyncSilent(client)— an immediate extra sync moves nothing over the wire. Built ontapWire(), anHttpSendinterceptor that records real traffic (download_entity200 vs 304,upload_entity). Any client/server hash divergence surfaces here as a re-download or re-upload.
tapWire() is the workhorse: assert what actually crossed the wire, not what the client claims it
did. The null-timestamp re-download bug was a 200 where a 304 belonged.
The three regimes
Sync output is a function of (client baseline, client ops, server ops). New tests should slot into
one of these:
| Regime | Setup | Oracle |
|---|---|---|
| First-time | client empty, server has entities | every entity pulled; client converges to server |
| No-change | nothing changed since last sync | assertResyncSilent — zero wire transfer |
| Mixed | creates / edits / deletes on one or both sides | assertConverged + assertResyncSilent; conflicts only where both sides touched the same entity |
Coverage map
First-time
ServerDownloadsEntityTest— server-only scene lands on a clean clientTwoDeviceSyncTest(a second device downloads…) — a second device adopts an existing project
No-change
ResyncStabilityMatrixTest— every entity type × edge-case field values, server-originated, resync silentUploadResyncStabilityMatrixTest— same matrix for client-created entitiesResyncDownloadsNothingTest— all types in one project; first sync pulls + heals, second is silentSyncHashStabilityTest,EditResyncNoConflictTest,ResyncBaselineScenariosTest,EntityTypeResyncMatrixTest,SyncedHashBackfillTest— targeted baseline / hash-agreement cases
Mixed
MixedSyncFuzzTest— seeded property test: random create/edit/delete/rename across all types, converge + silentTwoDeviceSyncTest(independent edits…) — two devices, disjoint edits, convergeIndependentEditsTest,ClientDeletionTest,ClientUploadsEntityTest,ServerOriginatedEntitiesTest— specific transitionsConflictPickClientTest,ConflictPickServerTest— the conflict sub-case (both sides touch one entity)SyncFuzzTest— single-entity edit/rename fuzz (legacy;MixedSyncFuzzTestis the broader net)
Adding tests
- A new scenario: extend
RoundTripTestBase, driveHeadlessClients, and finish withassertConverged/assertResyncSilentrather than hand-rolled state checks. - Two devices on one project:
secondDeviceFor(primary, localName). The primary must have synced once. A second device that creates entities after adopting should re-open its editor (initializeSceneEditor()) first, mirroring a real session re-deriving its next id. - More fuzz coverage: add seeds to
MixedSyncFuzzTest.SEEDS(a failure prints the seed + iteration to replay). - Scripted "other device" changes:
seedServerEntity/mutateServerEntity/seedServerEntityDeletion(+ bumplast_id) set server state directly — more faithful than a second real client for server-originated changes, since it sidesteps shared client-side id allocation.