edde746
3f49bcabf8
Upstream shared_preferences_windows and _linux write the whole preference document with a bare `writeAsStringSync`. That opens with the default `FileMode.write`, which truncates the live file before writing it, so every single preference write has a window in which the only copy on disk is empty or half-written. A crash, power loss, forced reboot or antivirus interception inside that window leaves a document that fails to parse on every subsequent launch — and the store holds the credential-vault key, so the loss is not recoverable by rewriting it. This is the corruption class behind #1732; the recovery path already landed is a band-aid over it. Vendor both packages under packages/ — the convention saf_util and wakelock_plus already follow — and stage, flush, then rename over the target. The flush has to precede the rename or it could publish contents that were never committed, the same corruption by another route. Staging uses one fixed sibling name rather than a stamped one, because the file is a plaintext copy of the vault key, tracker refresh tokens and Seerr cookies; it is created in the target's own directory so rename stays on one volume and the mode matches what the canonical file would have had, and a stale one is swept once the canonical document has been read cleanly. Both deltas are marked in-source and in provenance.json with the refresh contract. Atomicity is proven, not asserted. A hard link to the store observes the old document after a write, which only holds when the directory entry was replaced — truncate-in-place would have rewritten the shared inode, and that test does fail against unpatched upstream. Upstream's own suites still pass unchanged in both packages and now run in CI, so the patch keeps the contract it inherited. Windows `MoveFileExW` replacement semantics cannot be proven on a POSIX runner or a memory file system, so they get their own test on the existing windows-latest job, including replacement while a reader holds the file open — antivirus and Search Indexer both do.
21 lines
1.2 KiB
JSON
21 lines
1.2 KiB
JSON
{
|
|
"formatVersion": 1,
|
|
"upstream": {
|
|
"repository": "https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences_windows",
|
|
"packageVersion": "2.4.1",
|
|
"source": "pub.dev"
|
|
},
|
|
"plezyDeltas": [
|
|
"atomic store replacement: stage to a sibling .tmp, flush, then rename over the target",
|
|
"stale staging files are swept once the canonical document has been read cleanly",
|
|
"the published example app is not vendored"
|
|
],
|
|
"refreshContract": [
|
|
"Diff against the new upstream version and reapply every PLEZY DELTA block in lib/shared_preferences_windows.dart verbatim.",
|
|
"Never reintroduce a bare writeAsStringSync onto the live document: it truncates before writing, which is the corruption in issue #1732.",
|
|
"Keep the staging name fixed and single. The file is a plaintext copy of the credential-vault key, tracker refresh tokens and Seerr cookies; stamped names would accumulate them.",
|
|
"Keep the flush before the rename. A rename can otherwise publish contents that were never committed.",
|
|
"Run flutter test test/services/prefs_store_atomic_write_test.dart from the repository root, and the real-Windows step in .github/workflows/ci.yml."
|
|
]
|
|
}
|