* craft-suite-account: the suite account list and keychain token store
Carries crates/suite-account over from the cut-down craft-libs#160 branch. This follows RFC-0025 (storytold/craft-contrib#35).
service.rs is removed. It was the CollabCraft device-flow client. Its Service, Flow, Identity, Polled and SignedOut types went with it. Store::sign_out is also gone. The provider adapter now owns ending a session at the deployment. Store::discard and Store::forget cover the local half that stays here.
Every remaining CollabCraft-specific word is reworded to a provider-neutral description. The one serde alias and the one test fixture name that spelled the old provider out are gone too.
Adds a generation field to Account, per RFC-0025's cross-app lifecycle guarantees. A sign-in bumps it. Store::update_token refuses a write made against a stale generation. A fuller tombstone for the removal case is left as a TODO referencing the RFC, documented on Accounts::remove.
Also drops one unused restrict() function found while verifying clippy -D warnings on Linux. It was pre-existing dead code. The unix write path already sets the file mode at creation.
* craft-suite-account: lock list mutations, make generations monotonic across removal
Fixes the three review gates on PR #665 (rev 2e9c84f).
Every mutation of accounts.json now goes through an OS-level file lock. The
lock is a sibling .lock file taken with std::fs::File::try_lock and a
bounded retry, matching the mechanism craft-ai-integrations' store already
uses for the same problem. Two processes each completing 100 sign-ins into
one folder used to leave 101 rows on file. Both the real two-process and
two-thread conformance tests now land all 200 rows.
A removed account now leaves a tombstone holding its last generation. A
re-add continues past that tombstone. It never restarts at 0.
update_token checks the generation twice. The first check runs before the
keychain is touched at all. An already-stale caller never overwrites a
newer token. The second check runs under the lock, after the keychain
write. It catches a removal that landed in the window that write opened. A
tombstoned account answers StaleGeneration. It never answers Unknown. The
second check also removes the token it just wrote, under the same lock,
when the account turns out to be gone. A refresh racing a discard can then
resurrect neither the row nor the keychain entry. discard itself now
removes the keychain entry inside the same lock hold as the list write.
The module docs now name the chosen keychain-versus-list write order for
each operation. They also name the state a crash in that window leaves
behind for the next reader to repair, per RFC-0025 guarantee 1. A new test
simulates the window update_token opens between its keychain write and its
generation commit.
The conformance tests are adapted from the maintainer's review-reproduction
gist for this crate. Forget racing a refresh is the one gist case left out.
forget is deliberately generation-agnostic and local, per RFC-0025
guarantee 4. That fix would be a separate, broader change than these three
gates.
* craft-suite-account: close the review gaps CodeRabbit found in the rebase
Six fixes. Generation bumps in sign_in, update_token and remove_with_tombstone
now use checked_add. A bump at the maximum refuses with GenerationExhausted.
It never wraps back to a small number a stale caller could pass again.
accounts::write now refuses a list that would serialize
past MAX_BYTES before touching disk. An oversized display name can then
never brick the list for every later reader. NewAccount.linked now persists
onto Account. It used to be silently dropped at sign_in. update_token's
stale-write cleanup now only removes a keychain token that still matches the
token it wrote itself. A concurrent sign-in's token for the same handle
survives that cleanup now. Store::forget and Store::has_token now return
Error::Isolated before touching the keychain, matching every other mutator.
migrate::adopt re-reads the legacy file right before deleting it and skips
the delete when something rewrote it since. The read buffers are wrapped in
Zeroizing too. A parsed-but-unused token copy no longer outlives the one
Secret already covers.
Three findings were not valid against this code and are not changed. The
torn-state window CodeRabbit flagged in update_token's generation commit is
the same crash recovery the module docs already describe. The existing
torn-state test already exercises it. Forcing the keychain write under the
same lock as two concurrent sign-ins for one handle would reintroduce the
cross-process deadlock the lock module exists to avoid. A failed discard
already reports its own error. A refresh that re-establishes a full session
afterward is recovery. It is never a silent mismatch.
* craft-suite-account: apply cargo fmt to the review-gap fixes
cargo fmt wraps the long struct literals and assert calls the previous
commit added. The content is unchanged.
* craft-suite-account: factor the race test's join-handle type out
clippy::type_complexity flagged the four-deep generic on handle_slot in the
stale-refresh-vs-re-sign-in test. A type alias clears it without changing
the test.
* craft-suite-account: flush before the rename, re-check the token under the lock
Two review findings. The temporary file is now flushed with sync_all before the rename, keeping the crash story the doc tells. A discard racing a sign-in could delete the token the sign-in had just written and the sign-in still reported Ok. The lock closure re-checks the keychain right before committing the row and writes the token again when something else changed it.
* craft-suite-account: sync the parent directory after the rename
The temp-file flush persists the bytes. The rename changes a directory entry with its own durability on Linux. Power loss after write returned could otherwise resurrect the older list and lose a tombstone a discard already reported written. A sync failure now reports an error, never success. Unix only, since directories do not open for sync elsewhere.
* craft-suite-account: keep activation out of refresh, require an explicit format marker, stop logging paths
Three fixes. update_token no longer calls Accounts::put for its row commit.
That call always makes the written row active. Refreshing an account in
the background used to silently steal the selection from whatever account
the person had actually picked. A new Accounts::refresh_in_place replaces
the row without touching active. put stays exactly as it was for sign_in
and set_active, the two calls meant to change it.
Accounts::format no longer carries #[serde(default)]. Every other field
still does. A missing format key used to default through Accounts's own
Default impl. That impl answers FORMAT. A file that never declared a
format therefore read as exactly the one format this build understands.
read now also rejects any parsed format that is not exactly FORMAT. The
old check only rejected a newer one; format 0 passed it the same way a
missing key did.
accounts::read's error messages now name only the file, never the full
path. Store::shared logs a read failure at warn. The path sits under the
user's profile folder.
restrict on Windows stays a no-op. Its comment now states the guarantee's
real scope. The default per-user config folder gives it. A portable
install or an ARTCRAFT_SUITE_DIR override does not. A real fix needs the
Win32 authorization API. Every binding for it is an unsafe fn. This
workspace forbids unsafe_code outright. That part of the finding is
refused in part. Closing it for real needs a maintainer-approved exception
for this one call site, or a vetted dependency wrapping that API safely.
Either is a decision for its own PR.
* craft-suite-account: move update_token's keychain write inside the lock
skylartaylor's finding. update_token used to write the keychain, then take
the list lock. A newer sign-in, or a discard followed by a re-add, could
land for the same handle in between. The second check under the lock
already answered StaleGeneration in that case, but the earlier write had
already landed over the newer session's token. shared() then served the
new session's row with the stale refresh's bytes. Deleting the stale token
on its own was never going to fix this; that still loses the newer
session, it only changes which bytes go missing.
The keychain write now happens only inside the lock, in the second
generation check's own success arm, immediately before the row commits.
The first, unlocked check still exists, purely to reject an already-stale
caller before it ever takes the lock; it writes nothing. Every losing
path, a newer sign-in, a discard, a discard followed by a re-add, now
answers with an error having never touched the keychain at all. There is
nothing stale left in it to clean up or weigh against a winner's own
token. Store::remove_token_if_still is gone. Its two call sites in the
losing branches never write a token to begin with now. Nothing is left
for it to conditionally remove.
This keeps the lock discipline the module docs describe: the write is
conditional on the row commit going ahead, the same shape as discard's own
keychain call inside its lock hold and sign_in's existing re-check, never
an unconditional call made regardless.
Two deterministic tests reproduce both orderings skylartaylor named, each
proving the fix against the pre-fix code before passing against the fix:
a_refresh_racing_a_newer_sign_in_for_the_same_handle_never_overwrites_its_token
and a_refresh_racing_a_discard_and_re_add_for_the_same_handle_never_overwrites_its_token.
Both hold the real accounts lock on a background thread standing in for
the winning operation. They release it only after the refresh's own
unlocked first check has had the chance to read the pre-race state. Both
then assert shared() serves the winning session's own token afterward.
The crate's own pre-existing hook-based race tests could no longer reach
the window they were built for, since that window no longer has a
keychain call in it to hook. tests/review_repro.rs's two Hooked-based
tests are rewritten onto real threads racing on a Barrier instead, the
same device the file's own two-thread sign-in test already uses. The lock
makes their outcomes hold for either ordering now. A hook could only ever
force one. The now-unused Hooked harness is removed along with them.
src/tests.rs's own matching hook-based test is replaced outright by the
two new ones above. That covers its ground and the newly found gap
together.
* craft-suite-account: pin the race tests' second-check window
skylartaylor's review note on PR 665: the two update_token race tests in
src/tests.rs send their release signal and then immediately call
update_token, so the competing sign-in or discard-and-re-add can finish
before the refresh's first, unlocked check ever runs. A pre-fix build
could then pass the same assertions by rejecting early at that first
check, never reaching the second, locked one the tests are named for.
Adds race_hook, a test-only pause point inside update_token between its
two checks. A test arms it, starts the refresh, waits for the refresh to
signal that its first check has read the pre-race generation, runs the
competing operation to completion, then releases the refresh into its
second check. Both race tests are rewritten onto this instead of holding
the real accounts lock on a background thread, which left the same gap
skylartaylor found: the lock never blocked the refresh's unlocked first
read, only its second, locked one.
* craft-suite-account: make the race test hook per store instead of process wide
CI runs this crate's suite with the default, parallel test runner. The
hook update_token pauses on between its two generation checks lived
behind one process wide slot, so when the Workspace gate's parallel run
landed both race tests at the same time, one test's release on that
slot answered the other test's pause: the pinned ordering collapsed,
the refresh ran ahead of the competing write, its second check legitimately
matched, and update_token returned Ok where the test expected
StaleGeneration. Reproduced on the lab build host with the crate's
default threaded test run; failed on the first attempt, matching the
CI failure exactly.
The hook now lives on the Store instance, one per store, armed only on
the exact store a given test built. A concurrent test's own store keeps
its own hook, so there is nothing left for two tests to cross no matter
how the runner schedules them. Checked the rest of the suite for the
same kind of shared state: every other test builds its own tempdir and
its own in-memory keychain, and the two-process test spawns its own
child with --test-threads=1 for that child's own run, so none of them
depend on the parent suite running single threaded.
This branch gated `pub mod menu;` behind the esign feature, which was right when main had no menu module of its own. #160 landed one, and its cloud pages use it (crates/ui/src/cloud/pages.rs, cloud/title.rs). The gate therefore broke every build with cloud on and esign off, which is what the workspace clippy leg does. The gate was the whole remaining content of the commit that carried the helper across.
This branch added craft-cloud to [workspace.dependencies] for the e-sign dialog's vocabulary. #160 added the same entry beside craft-cloud-local while this branch waited, in a different place in the list, so the rebase kept both and cargo refused the manifest. Main's entry stays. Cargo.lock is regenerated on the new base.
The send helper submitted the create immediately, consuming the captured context before the status request ran. The test now queues and takes document A's send without submitting it, leaving the context pending. That pending context is the scenario the guard exists for.
submit_request consumed the captured send context for every request kind. A status refresh for the current document submitted while another document's send was still outstanding then carried the old context. pump dropped its reply as stale. The context now goes only to the create submission that answers the taken send request. Every other request uses the current context.
A public submit_request call carrying Request::Status never registered
status_seq. Its own reply then failed the supersession guard. The dialog
kept showing an envelope's old state. submit_request now records
status_seq for a Status submission the same way status_panel's own button
already does.
Once available() turns true it never asks again. A backend whose linked
value changes after an out-of-band sign-in stayed stuck showing the
sign-in message. A new reset_capabilities method reprobes the current
backend. It reuses the same reset set_backend already performs.
Recipient roles were derived from the current recipient count. Add two
recipients, remove the first, then add a third: the third gets the
second's exact role. A placement keyed to a removed recipient's role
could then bind to whichever recipient later receives that reused label.
Roles now come from a counter that only climbs. A recipient removal also
drops any placement keyed to a role no recipient holds anymore.
Both Close buttons set self.open to false inside the window's content
closure. show() then overwrote it with the window's own unchanged open
binding, undoing the click. show() now requires both to agree the dialog
stays open.
The manual status refresh button showed the English "Refresh status"
caption regardless of the labels a host supplied. EsignLabels gained a
refresh field for it.
Each fix adds a test that fails without it.
The is_caps_reply guard from the earlier commit had no test of its own. A
reply from a replaced backend now provably cannot overwrite the new
backend's capabilities, responsible party or linked state.
A reply from a replaced backend could overwrite capabilities for the new
one. A reply for an older document revision could install under a reopened
dialog. A send request taken before a reopen could tag its reply with the
wrong context. A duplicate answer from a backend holding a second Replier
could reinstall state the dialog had already moved past. A superseded
status refresh could overwrite a newer one. A failed lookup could clear
busy for a create that was still running.
Placements and the draft idempotency key could also survive a document
change or a field edit that should have invalidated them. A contact with no
email address could become a recipient using its share id as the address.
Two dialog instances could mint the same idempotency key for the same
document. An unlinked account showed a disabled Send button with no
explanation.
The context model now carries the document revision and an opening counter
alongside the document id and account. Pending-send context is captured at
queue time and consumed by the eventual submit or result call. A late reply
or result keeps the context it was built under. Each fix adds a test that
fails without it.
Main's craft-ui no longer has a standalone menu module. The esign dialog is the only consumer of the split-button helper this slice carries. The module is therefore feature-gated so the default craft-ui build matches main exactly. The three widget_info calls move from the deprecated egui::WidgetType alias to egui::Role. The current pin denies that deprecation as a warning.
Fixes three gate items skylartaylor raised on PR #661. He reproduced them
against 0a937ef in
https://gist.github.com/skylartaylor/c1108ecf20d63c5e3183947408ddab7a.
The request-signatures dialog now tags every in-flight create, status,
completed, void and remind request with the context that issued it. That
context is the document identity plus the account identity. A reply
installs only when that context still matches the dialog's current
context. This replaces the old staleness rule. That rule keyed off a global
sequence counter that typing in the signer search also bumped. It dropped a
late create reply and left the dialog on Sending forever.
CompletedDocument now carries original_content_sha256 and
signed_content_sha256 as distinct fields, per RFC-0021's evidence guarantee
in storytold/craft-contrib#37. The crate's in-process test double computes
both from the bytes it actually holds. It applies a fake seal that changes
the signed bytes first. The two digests are never conflated.
Regression tests, all in crates/ui/src/esign/review_repro.rs unless noted:
1. review_h5_reply_for_previous_document_is_installed_after_reopen
2. review_h5_reply_for_previous_account_is_installed_after_account_switch
3. review_n1_create_reply_dropped_after_a_lookup_leaves_dialog_busy
4. completed_document_keeps_original_and_signed_digests_distinct, in crates/esign/src/lib.rs
This carries over crates/esign and craft-ui's esign dialog from the cut-down #160 branch, with minimal workspace wiring. The esign dialog speaks only craft_cloud::Contact and craft_esign types. This also brings crates/cloud along as a dependency until PR #160 lands on main.