Investigate how interlinear data interacts with Send/Receive
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- typescript
- Ambito
- backend, distributed-systems
Direzione di ricerca
Inizia con src/services/projectStorage.ts e le API citate extension-storage e project-data-provider per confrontare l’archiviazione per utente con project ExtensionData. Poi traccia auto-sync-blocking-service.ts, onSyncWriteLockChanged, onSyncStateChanged e onSyncProgress, insieme al C# provider citato e alla documentazione sul partizionamento di PT9. Il lavoro è completato quando esiste un documento decisionale che copre la posizione di archiviazione, la granularità del merge, il controllo delle scritture, la gestione dei dati ricevuti, le versioni del modello e le issue successive.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Split out of an aside on #44: "Will the in-interlinearizer lexicon be in the interlinear project envelope or being saved to file? Will we implement it with Harmony? How will the project interact with send/receive that's now enabled in PT10?" Nothing about S/R has been decided. Where our data lives today answers the question by accident rather than by design, and the answer it gives is "not at all".
Investigation and a decision record; no implementation in this issue.
Where the data is now
Every read and write goes through papi.storage.readUserData / writeUserData in src/services/projectStorage.ts. Core resolves those to app://<extension data dir>/interlinearizer/user-data/<base64url key> (paranext-core: src/extension-host/services/extension-storage.service.ts:67-138, buildUserDataUri) — per user, per machine, per extension, outside every Paratext project folder.
Consequences, none of them chosen:
- An interlinear project cannot be shared with a team at all, by any mechanism.
- It does not follow the user to another machine, and is not backed up with the project.
- S/R cannot see it, so it also cannot conflict — the only upside.
What PT9 does, for contrast
PT9 interlinear data is a first-class synced project file type. S/R's ProjectFileType list includes interlinear ("Any file name that starts with Interlinear_") alongside lexicon (Lexicon.xml or WordAnalyses.xml) and pluginData (paranext-core: src/@types/paratext-bible-send-receive/index.d.ts:142-179). PT9 partitions as Interlinear_<lang>_<book>.xml (src/parsers/pt9/pt9-xml.md), which is also its merge granularity.
So a PT9 team already shares glosses, and a PT10 team using this extension would not — a regression from the tool we are replacing. It also breaks #150 in a specific way: importing from a synced Interlinear_*.xml into unsynced per-user storage means the two copies diverge from the first receive onward, with nothing detecting it.
The alternative that already exists
Every PDP has an ExtensionData endpoint — getExtensionData / setExtensionData scoped by { extensionName, dataQualifier } (paranext-core: src/shared/models/project-data-provider.model.ts:14-130). For a Paratext project, core's C# writes it to <project>/shared/platform.bible/extensions/<extensionName>/<dataQualifier> (paranext-core: c-sharp/Projects/ParatextProjectDataProvider.cs:327-386, c-sharp/Projects/LocalParatextProjects.cs:19) — inside the project's shared directory, which S/R classifies as sharedFiles.
That is the switch: moving there is what makes the data travel, and it is also what exposes our blob to Mercurial merge.
Questions to answer
-
In the project, or per user? Is an interlinear draft team data or personal scratch? Note the model already assumes project-scoped identity in places:
sourceProjectId/targetProjectId, and the model-project and output-project pointers in #148 and #149 are PAPI project ids, which are not portable to another machine. If the answer is "team data", the storage layer is the change, andprojectStorage.tsis the only place that touches storage. -
Merge granularity. One JSON blob per project conflicts on every concurrent edit, and
TextAnalysisis flat unordered arrays — close to worst case for a line-based merge. PT9's per-book/per-language split and #87's proposed per-book partitioning point the same way. Find out what PT10 offers here: PT9 hadPluginDataMergeKeys.xmlfor exactly this problem (it is in thepluginDatafile type), and whether anything equivalent applies toshared/platform.bible/extensionsneeds to be established, not assumed. -
The sync write gate. Core exposes one:
paratextBibleSendReceive.onSyncWriteLockChangedandgetAutoSyncBlockingdriveauto-sync-blocking-service.ts, which blocks writes to a syncing project. On the C# sideSetExtensionDataruns insideEnterSyncWriteScope()and an entire-project write lock (paranext-core:ParatextProjectDataProvider.cs:345-373). Our autosave (#119) writes on every edit and knows nothing about any of this. Note the gate only ever arms in Paratext 10 Studio builds — in plain Platform.Bible there is no S/R and one not-blocking baseline snapshot per backend start — so this is a Studio-only concern, which is also why it will not show up in our own testing. -
Reacting to a receive.
onSyncStateChanged/onSyncProgresscarryFileChangesInfo: whichProjectFileTypes changed and, forbooks, which book numbers (paranext-core: seam file:98-196,:478-492). A receive that rewrites the source text of the book on screen is exactly the drift scenario #139 (staleness), #136 (re-anchoring), and #156 (lost segment boundaries) describe — and today we would neither notice nor tell the user, whichever storage we use. Decide whether we subscribe, and what we do when the answer is "the book you are glossing just changed". -
Model version across a team.
assertSupportedModelVersionrefuses a record stamped newer than this build. Over S/R a teammate on a newer build pushes exactly that, into a file we then refuse to read and refuse to overwrite. #232 covers telling the user; S/R turns it from an edge case into a routine one, and the recovery story ("wait for your build to update, and do not touch it") needs to be deliberate. -
Two sync systems over one set of references. The lexicon half of #44: if the lexicon side is Harmony/CRDT-backed via FW Lite while glosses ride S/R's Mercurial merge, then
entryRef/senseRef/glossSenseRef(#225, #226, #227) are references crossing between two sync systems with different merge semantics and different conflict outcomes. Establish which system owns what, and what a dangling cross-system reference looks like after a conflict.
Deliverable
A decision record covering: where analysis data lives, at what partition granularity, whether we participate in the write gate, and whether we react to receive events — plus follow-up issues for whatever it commits to. Not a code change.
Related
One per question above: #44 (source of the question), #150 (imports from a synced file into unsynced storage), #87 (per-book partitioning is also the merge granularity), #119 (autosave versus the write gate), #139 (a receive is the drift trigger), #232 (a teammate's newer build), #225 (refs crossing two sync systems).
- Lingua principale
- TypeScript
- Stelle
- 2
- Fork
- 0
- Merge medio
- 2g 5h
- PR unite (30g)
- 46
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di sillsdev/interlinearizer-extension
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
sillsdev/interlinearizer-extension#388 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
sillsdev/interlinearizer-extension#383 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 65/100
sillsdev/interlinearizer-extension#382 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 54/100
sillsdev/interlinearizer-extension#379 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
sillsdev/interlinearizer-extension#369 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di sillsdev/interlinearizer-extension
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
siyuan-note/siyuan#20313 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 92/100
alunduil/projects-v2-sync#14 ·
-
Service process inherits the caller's cwd at first use, holding that folder open on Windows (EBUSY)Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
DevTools page styles leak into the host app in developmentForse già presa @onmax l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
nuxt-modules/better-auth#567 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno