Skip to content

fix(selector): release token locks on transaction settlement - #2400

Closed
adecaro wants to merge 1 commit into
fix/2395-sherdlock-antijoin-orderingfrom
fix/2395-release-locks-on-settlement
Closed

adecaro wants to merge 1 commit into
fix/2395-sherdlock-antijoin-orderingfrom
fix/2395-release-locks-on-settlement

Conversation

@adecaro

@adecaro adecaro commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Stacked on #2399. Implements Phase 5 (final phase) of #2395 — the fourth
contributing mechanism identified in the stress load-test incident: no
production code path released a transaction's selection locks on success.

Transaction.Release (the only production Unlock caller) was registered
solely against context.OnError — view.Context exposes no success hook. So
a settled transaction's locks sat until the sherdlock lease-expiry sweep
(several minutes, by config), during which its tokens stayed invisible to the
Phase 4 anti-join and kept colliding.

  • Both places that already compute terminal transaction status now release
    locks once that status is known: finality.Listener.runOnStatus (the live
    finality subscription) and TTXRecoveryHandler.applyFinalityLogic
    (recovery on restart) — for both Confirmed and Deleted, since a
    failed transaction will never spend the tokens it selected either.
  • A new finality.SelectorManagerProvider resolves the token.SelectorManager
    bound to a fixed TMS, re-resolving it on every call rather than caching it —
    mirroring the existing TokenRequestHasher.ProcessTokenRequest pattern.
  • Release is best-effort: a failed Unlock is logged and does not fail the
    settlement/recovery path (mirrors Transaction.Release's existing style);
    the lease-expiry sweep remains the backstop for Orphan consumers (which the
    finality path never observes) and for any release call that failed.
  • Wired at all three production construction sites: ttx.Service.Append,
    auditor.Service.Append (a harmless no-op unlock for the auditor role, which
    never itself locks tokens), and the Fabric recovery-manager wiring.

Why the contention benchmark shows no change here

TestHotTokenContention (the harness used to baseline Phases 3-4) is
structurally blind to this mechanism: it calls Select and then immediately
deletes/spends the tokens synchronously against the store, never routing
through the TTX finality settlement path where this PR's Unlock hook lives.
Re-running it before/after this change on the same environment gives identical
numbers:

distinct tokens attempted=300, total lock attempts=3353, total conflicts=3053,
conflict rate=0.91, distinct tokens conflicted=202, max single-token conflict share=0.10

This is expected, not a regression — mechanism 4 is a settlement-timing bug
(locks outliving a settled transaction by minutes), not a selection-time
contention bug, so it needs a harness that actually waits on finality to
observe. The correct verification for this PR is at the unit level: new tests
assert Unlock fires exactly once per transaction, for both Confirmed and
Deleted, and that a failing Unlock does not fail settlement/recovery
(TestOnStatus_ReleasesLocksAfterTerminalStatus,
TestTTXRecoveryHandler_Recover_ReleasesLocksOnConfirmed,
TestTTXRecoveryHandler_Recover_ReleasesLocksOnDeleted,
TestTTXRecoveryHandler_Recover_LockReleaseErrorDoesNotFailRecovery).

Docs

Updated docs/services/selector.md — new "Release on settlement" section, and
reframed "Lease expiry" as the backstop it now is rather than the sole release
mechanism.

Test plan

  • make lint-auto-fix clean
  • make checks clean
  • go test ./token/services/ttx/... ./token/services/auditor/... ./token/services/network/fabric/... (incl. -race) — all pass
  • New unit regression tests for lock release on Confirmed/Deleted, and for release-error not failing settlement
  • Integration tests (fabtoken/dlog T1) — not yet run

Fixes #2395

@AkramBitar AkramBitar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logic is correct and tests/vet are clean. Two issues undercut the fix, plus the self-flagged [ ] integration tests.

} else {
t.metrics.DeletedTransactions.Add(1)
}
releaseLocks(ctx, t.logger, t.selectorManagerProvider, txID)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Release runs after Commit, which ends in NotifyStatus. The woken client can return from Finality and start its next Select while these lock rows still exist, so the Phase-4 anti-join keeps hiding the tokens — the contention this PR removes.

Release before NotifyStatus, or defer it at the top of runOnStatus.

if sm == nil {
return
}
if err := sm.Unlock(ctx, txID); err != nil {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ctx is the caller's cancellable context. recovery.Manager.callHandler abandons this goroutine when TransactionTimeout fires, but tx.Commit() takes no ctx and NotifyStatus uses WithoutCancel — so execution reaches here with a canceled ctx, the DELETE fails instantly, and the lock waits out the full leaseExpiry.

Use context.WithoutCancel(ctx), as Transaction.Release already does ("we need to unlock even if t.Context is canceled").

A transaction's selection locks previously lingered until the sherdlock
lease-expiry sweep (several minutes by default), regardless of whether
the transaction had already reached a terminal status. During that
window the already-spent-for tokens stayed locked and invisible to
concurrent selectors, making them collide on the same hot tokens
(mechanism 4 of #2395).

Release the locks as soon as a transaction's status is known to be
terminal, in the two places that already compute it: the live finality
listener (Listener.runOnStatus) and the recovery path
(TTXRecoveryHandler.applyFinalityLogic). Both Confirmed and Deleted
transactions release, since a failed transaction will never spend its
selected tokens either. Release is best-effort and never fails the
settlement/recovery path; the lease-expiry sweep remains as a backstop
for Orphan consumers and any release call that failed.

A new finality.SelectorManagerProvider resolves the token.SelectorManager
for a fixed TMS, re-resolving it on every call rather than caching it,
mirroring TokenRequestHasher's existing pattern.

Fixes #2395

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: Angelo De Caro <adc@zurich.ibm.com>
@adecaro
adecaro force-pushed the fix/2395-sherdlock-antijoin-ordering branch from 655b435 to 0781e82 Compare September 22, 2026 15:20
@adecaro
adecaro force-pushed the fix/2395-release-locks-on-settlement branch from 1892c06 to d3ef574 Compare September 22, 2026 15:21
adecaro added a commit that referenced this pull request Sep 22, 2026
…ase 6, #2395)

Stacked on #2400. Attacks the lock-acquisition mechanism itself, on top of
the 4-PR correctness stack: every replica still reads the same anti-join
snapshot, picks the same smallest candidate, and raced a plain INSERT,
surfacing a lost race as a server-side unique-constraint violation.

- token.storage.db.lockStrategy selects insert (default, unchanged) /
  onConflict / skipLocked on the Postgres TokenLockStore. sqlite reads and
  ignores the key; simple never reaches this config path, so both are
  untouched by construction.
- onConflict and skipLocked replace the plain INSERT with
  INSERT ... ON CONFLICT DO NOTHING RETURNING: a lost race is a clean
  zero-row result, not a server error.
- skipLocked additionally implements BatchLocker.LockBatch: a covering
  window of candidates is claimed in one statement against the Tokens rows
  under FOR UPDATE OF <tokens> SKIP LOCKED, so a claimant walks past a row a
  concurrent claimant is already mid-claim on. selectInternal type-asserts
  for BatchLocker and claims the whole window in one round trip when
  available, falling back to the one-at-a-time Lock path otherwise.
- HasEnoughSpendableTokens (common/tokens.go) lets the empty-anti-join
  fallback fail immediately on a genuinely unpayable wallet instead of
  burning the full backoff budget first.
- Round-trip / unique-violation instrumentation (RoundTrips/UniqueViolations
  on TokenLockStore) makes the actual effect measurable directly, since the
  literal lock-conflict rate does not move across strategies: FOR UPDATE
  SKIP LOCKED only helps against a rival mid-claim at the same instant, not
  against an already-committed lock, the dominant conflict mode under load.
  Verified against real Postgres: insert produces real unique-constraint
  violations on the single-token Lock path (thousands in one run);
  onConflict/skipLocked produce zero. Round-trip savings come from batching
  the claim into one statement per covering window, uniform across
  strategies, not from strategy choice.

New tests: TestTokenLockStore_LockBatch_SkipLocked_SkipsRowLockedByConcurrentTx
proves the SKIP LOCKED mechanism directly against real Postgres (skips a row
a concurrent tx holds; a plain FOR UPDATE on the same row genuinely blocks).
TestHotTokenContention_SingleTokenLockPath forces the single-token Lock path
via a singleTokenOnlyLocker adapter to give the unique-violation counter its
first genuinely differentiated result. TestHotTokenContention and
TestHotTokenContentionWideWindow now run across all three strategies.

Docs: docs/services/selector.md gets a new "Lock-acquisition strategies"
section, scoping the unique-violation-elimination benefit to the
single-token Lock path (LockBatch already avoids the server error under
every strategy once a store implements BatchLocker) and the round-trip
saving to batching itself.

Fixes #2395

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: Angelo De Caro <adc@zurich.ibm.com>
@adecaro

adecaro commented Sep 23, 2026

Copy link
Copy Markdown
Contributor Author

Superseded by #2410, which consolidates Phases 3-8 of #2395 into a single PR on top of #2397.

@adecaro adecaro closed this Sep 23, 2026
@adecaro
adecaro deleted the fix/2395-release-locks-on-settlement branch September 23, 2026 04:58
@adecaro
adecaro removed this pull request from stack #2401 September 23, 2026 05:08
AkramBitar added a commit that referenced this pull request Oct 2, 2026
The sherdlock token selector made a small number of "hot" tokens absorb the vast
majority of lock collisions, surfacing as spurious "insufficient funds" errors
under concurrent load (#2395). Six mechanisms contributed; this closes all of
them, consolidating the #2398-#2403 stack (Phases 3-8) on top of #2397's
diagnostics and baseline. Supersedes #2398, #2399, #2400, #2402, #2403.

1. Anti-join: the candidate query excludes already-locked tokens, so selectors
   stop queueing up to fight over the same row.
2. Amount-ordered candidates plus shuffle: tokens are fetched smallest-first so
   a small payment does not grab a large token, and equal-amount candidates are
   shuffled so contention does not simply shift onto whichever token sorts
   first.
3. Sufficiency-window randomization: once the ascending scan reaches a token
   that alone covers the remaining amount, a bounded lookahead picks uniformly
   among similarly-sized candidates - count-capped by sufficiencyWindow and
   magnitude-capped by maxSufficiencyRatio, anchored on the anchor token itself
   so the window does not collapse to size 1 when every candidate dwarfs the
   request.
4. Blacklisting: a token that lost a lock race is skipped for the rest of that
   Select call instead of being retried in a tight loop for minutes.
5. Immediate lock release on settlement: a transaction reaching a terminal
   status releases its locks through the finality listener and the recovery
   handler, rather than holding them until the lease-expiry sweep. Busy and
   Unknown are explicitly non-terminal and leave locks alone; OnError and a
   retry-exhausted OnStatus release exactly once.
6. Postgres lock strategies: onConflict and skipLocked avoid server-side
   unique-constraint violations on lost races, and LockBatch claims a covering
   window of candidates in one round trip.

Review follow-ups folded in: the fast-fail balance check compares against the
full requested quantity rather than the remaining amount, which it had been
double-counting; a batch-lock store error refetches the window instead of
silently dropping it, bounded by the existing retry budget; the EVM recovery
handler releases selection locks like its Fabric counterpart; the now-unused
HasAnySpendableTokens is removed from the driver interface and its
implementations; and benchmark_test.go's pre-existing ireturn/thelper lint
breakage is fixed.

Two accuracy fixes from the last review round: StaleCandidates is incremented on
the single-token lock path only - LockBatch reports just the tokens it won, so a
stale candidate is indistinguishable there from a lost race and is booked as
LockConflicts - which the counter's own documentation and the metrics page had
claimed otherwise, and the batch branch now records the three consequences that
follow from it. maxSufficiencyRatio also gains deterministic coverage: in both
sufficiency-window tests the count cap binds first, so the ratio bound could be
disabled without either of them noticing.

Tests: hot-token contention suites reproducing the CERT incident's Pareto shape
and its static-hot-token variant, a simple-driver baseline, lock-outcome
classification across both the single-token and batch paths, stale-candidate
handling on both, the sufficiency-window and ratio-boundary ordering tests, and
finality listener/recovery coverage for every status transition that touches
locks.

Signed-off-by: AkramBitar <akram@il.ibm.com>
AkramBitar added a commit that referenced this pull request Oct 2, 2026
The sherdlock token selector made a small number of "hot" tokens absorb the vast
majority of lock collisions, surfacing as spurious "insufficient funds" errors
under concurrent load (#2395). Six mechanisms contributed; this closes all of
them, consolidating the #2398-#2403 stack (Phases 3-8) on top of #2397's
diagnostics and baseline. Supersedes #2398, #2399, #2400, #2402, #2403.

1. Anti-join: the candidate query excludes already-locked tokens, so selectors
   stop queueing up to fight over the same row.
2. Amount-ordered candidates plus shuffle: tokens are fetched smallest-first so
   a small payment does not grab a large token, and equal-amount candidates are
   shuffled so contention does not simply shift onto whichever token sorts
   first.
3. Sufficiency-window randomization: once the ascending scan reaches a token
   that alone covers the remaining amount, a bounded lookahead picks uniformly
   among similarly-sized candidates - count-capped by sufficiencyWindow and
   magnitude-capped by maxSufficiencyRatio, anchored on the anchor token itself
   so the window does not collapse to size 1 when every candidate dwarfs the
   request.
4. Blacklisting: a token that lost a lock race is skipped for the rest of that
   Select call instead of being retried in a tight loop for minutes.
5. Immediate lock release on settlement: a transaction reaching a terminal
   status releases its locks through the finality listener and the recovery
   handler, rather than holding them until the lease-expiry sweep. Busy and
   Unknown are explicitly non-terminal and leave locks alone; OnError and a
   retry-exhausted OnStatus release exactly once.
6. Postgres lock strategies: onConflict and skipLocked avoid server-side
   unique-constraint violations on lost races, and LockBatch claims a covering
   window of candidates in one round trip.

Review follow-ups folded in: the fast-fail balance check compares against the
full requested quantity rather than the remaining amount, which it had been
double-counting; a batch-lock store error refetches the window instead of
silently dropping it, bounded by the existing retry budget; the EVM recovery
handler releases selection locks like its Fabric counterpart; the now-unused
HasAnySpendableTokens is removed from the driver interface and its
implementations; and benchmark_test.go's pre-existing ireturn/thelper lint
breakage is fixed.

Two accuracy fixes from the last review round: StaleCandidates is incremented on
the single-token lock path only - LockBatch reports just the tokens it won, so a
stale candidate is indistinguishable there from a lost race and is booked as
LockConflicts - which the counter's own documentation and the metrics page had
claimed otherwise, and the batch branch now records the three consequences that
follow from it. maxSufficiencyRatio also gains deterministic coverage: in both
sufficiency-window tests the count cap binds first, so the ratio bound could be
disabled without either of them noticing.

Tests: hot-token contention suites reproducing the CERT incident's Pareto shape
and its static-hot-token variant, a simple-driver baseline, lock-outcome
classification across both the single-token and batch paths, stale-candidate
handling on both, the sufficiency-window and ratio-boundary ordering tests, and
finality listener/recovery coverage for every status transition that touches
locks.

Signed-off-by: AkramBitar <akram@il.ibm.com>
AkramBitar added a commit that referenced this pull request Oct 2, 2026
The sherdlock token selector made a small number of "hot" tokens absorb the vast
majority of lock collisions, surfacing as spurious "insufficient funds" errors
under concurrent load (#2395). Six mechanisms contributed; this closes all of
them, consolidating the #2398-#2403 stack (Phases 3-8) on top of #2397's
diagnostics and baseline. Supersedes #2398, #2399, #2400, #2402, #2403.

1. Anti-join: the candidate query excludes already-locked tokens, so selectors
   stop queueing up to fight over the same row.
2. Amount-ordered candidates plus shuffle: tokens are fetched smallest-first so
   a small payment does not grab a large token, and equal-amount candidates are
   shuffled so contention does not simply shift onto whichever token sorts
   first.
3. Sufficiency-window randomization: once the ascending scan reaches a token
   that alone covers the remaining amount, a bounded lookahead picks uniformly
   among similarly-sized candidates - count-capped by sufficiencyWindow and
   magnitude-capped by maxSufficiencyRatio, anchored on the anchor token itself
   so the window does not collapse to size 1 when every candidate dwarfs the
   request.
4. Blacklisting: a token that lost a lock race is skipped for the rest of that
   Select call instead of being retried in a tight loop for minutes.
5. Immediate lock release on settlement: a transaction reaching a terminal
   status releases its locks through the finality listener and the recovery
   handler, rather than holding them until the lease-expiry sweep. Busy and
   Unknown are explicitly non-terminal and leave locks alone; OnError and a
   retry-exhausted OnStatus release exactly once.
6. Postgres lock strategies: onConflict and skipLocked avoid server-side
   unique-constraint violations on lost races, and LockBatch claims a covering
   window of candidates in one round trip.

Review follow-ups folded in: the fast-fail balance check compares against the
full requested quantity rather than the remaining amount, which it had been
double-counting; a batch-lock store error refetches the window instead of
silently dropping it, bounded by the existing retry budget; the EVM recovery
handler releases selection locks like its Fabric counterpart; the now-unused
HasAnySpendableTokens is removed from the driver interface and its
implementations; and benchmark_test.go's pre-existing ireturn/thelper lint
breakage is fixed.

Two accuracy fixes from the last review round: StaleCandidates is incremented on
the single-token lock path only - LockBatch reports just the tokens it won, so a
stale candidate is indistinguishable there from a lost race and is booked as
LockConflicts - which the counter's own documentation and the metrics page had
claimed otherwise, and the batch branch now records the three consequences that
follow from it. maxSufficiencyRatio also gains deterministic coverage: in both
sufficiency-window tests the count cap binds first, so the ratio bound could be
disabled without either of them noticing.

Tests: hot-token contention suites reproducing the CERT incident's Pareto shape
and its static-hot-token variant, a simple-driver baseline, lock-outcome
classification across both the single-token and batch paths, stale-candidate
handling on both, the sufficiency-window and ratio-boundary ordering tests, and
finality listener/recovery coverage for every status transition that touches
locks.

build(tools): bump staticcheck to v0.8.1 so make checks runs under Go 1.27

staticcheck v0.7.0 panics in its own IR builder (unexpected expr:
*ast.KeyValueExpr) against this module's Go 1.27.1 toolchain, on packages
unrelated to this change, which makes the checks-heavy stage of make checks
unrunnable locally. v0.8.1 (2026.2.1) analyses the same tree cleanly with no new
findings. Separable from the selector fix if a maintainer prefers it on its own.

Signed-off-by: AkramBitar <akram@il.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

sherdlock selector: hot-token lock contention causes false insufficient-funds under load

2 participants