Skip to content

perf: keep request creation ahead of refreshes #1661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ben-kaufman wants to merge 2 commits into
base: codex/paykit-inbox-observation
Choose a base branch
from
+137 −0
Open

perf: keep request creation ahead of refreshes #1661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e552783
perf: keep request creation ahead of refreshes
ben-kaufman Oct 21, 2026
c475334
merge updated payment latency parent
ben-kaufman Oct 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions app/src/main/java/to/bitkit/repositories/PaykitPaymentRequestRepo.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,6 +748,7 @@ class PaykitPaymentRequestRepo @Inject constructor(
): Result<PaykitPaymentRequestCreation> = withContext(ioDispatcher) {
runSuspendCatching {
if (!creationMutex.tryLock()) throw PaykitPaymentRequestError.OperationInProgress
var endReview: (() -> Unit)? = null
_isCreatingRequest.update { true }
try {
operationMutex.withLock {
Expand All @@ -757,6 +758,7 @@ class PaykitPaymentRequestRepo @Inject constructor(
if (draft.amount.atomic == 0uL || !isAvailable()) throw PaykitPaymentRequestError.RequestUnavailable
if (draft.expiresAt <= proposalDate) throw PaykitPaymentRequestError.RequestExpired

endReview = paykitSdkService.beginPaymentReview()
val selectedSavedKey = savedPublicKeys.firstOrNull {
PubkyPublicKeyFormat.matches(it, target.publicKey)
}
Expand Down Expand Up @@ -795,6 +797,7 @@ class PaykitPaymentRequestRepo @Inject constructor(
publishCreatedRequest(request, generation, expectedIdentity)
}
} finally {
endReview?.invoke()
_isCreatingRequest.update { false }
creationMutex.unlock()
}
Expand Down
134 changes: 134 additions & 0 deletions app/src/test/java/to/bitkit/repositories/PaykitPaymentRequestRepoTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,7 @@ class PaykitPaymentRequestRepoTest : BaseUnitTest(StandardTestDispatcher()) {
paymentSubmissionActive.value = it.getArgument(0)
Unit
}
doAnswer { {} }.whenever(paykitSdkService).beginPaymentReview()
stubMessageProcessing()
whenever(settingsStore.isPaykitEnabled).thenReturn(flowOf(true))
whenever(settingsStore.data).thenReturn(flowOf(SettingsData(sharesPrivatePaykitEndpoints = true)))
Expand Down Expand Up @@ -2298,6 +2299,121 @@ class PaykitPaymentRequestRepoTest : BaseUnitTest(StandardTestDispatcher()) {
assertTrue(sut.eligibleTargets.value.isEmpty())
}

@Test
fun `creation holds review through eligibility and targeted delivery without ending another review`() = test {
val activity = stubPaymentReview()
val record = paymentRequestRecord(role = PaymentRequestLocalRole.PAYEE).copy(proposalOutboundMessageId = 7uL)
val target = stubProposal(record)
val draft = PaykitPaymentRequestDraft(PaykitAmount(PaykitAsset.BTC, 1uL), "Lunch", clock.now().plus(60.seconds))
val finishIdentity = CompletableDeferred<Unit>()
val finishDelivery = CompletableDeferred<Unit>()
whenever(paykitSdkService.identityStatus()).doSuspendableAnswer {
assertFailsWith<PaykitPaymentRequestError.OperationInProgress> {
activity.checkRefreshAdmission(Priority.Background)
}
finishIdentity.await()
IdentityStatus(LOCAL_IDENTITY, PubkyIdentityCapability.PRIVATE_LINK_CAPABLE)
}
whenever(paykitSdkService.proposePaymentRequest(any(), any(), eq(LOCAL_IDENTITY))).doSuspendableAnswer {
assertFailsWith<PaykitPaymentRequestError.OperationInProgress> {
activity.checkRefreshAdmission(Priority.Background)
}
record
}
whenever(paykitSdkService.processOutboundPrivateMessages(COUNTERPARTY)).doSuspendableAnswer {
finishDelivery.await()
OutboundPrivateSendReport(listOf(7uL), listOf(7uL), emptyList(), emptyList(), emptyList())
}
val proposal = async { sut.propose(draft, target, listOf(COUNTERPARTY)).getOrThrow() }
runCurrent()
assertTrue(sut.isCreatingRequest.value)
assertFalse(activity.isPaymentSubmissionActive.value)
activity.checkRefreshAdmission(Priority.Ordered)
activity.checkRefreshAdmission(Priority.Interactive)
finishIdentity.complete(Unit)
runCurrent()
verify(paykitSdkService).processOutboundPrivateMessages(COUNTERPARTY, Priority.Interactive)
assertFailsWith<PaykitPaymentRequestError.OperationInProgress> {
activity.checkRefreshAdmission(Priority.Background)
}
val finishOther = activity.beginPaymentReview()
finishDelivery.complete(Unit)
assertEquals(PaykitPaymentRequestDeliveryStatus.Sent, proposal.await().request.deliveryStatus)
assertFalse(sut.isCreatingRequest.value)
assertFailsWith<PaykitPaymentRequestError.OperationInProgress> {
activity.checkRefreshAdmission(Priority.Background)
}
finishOther()
activity.checkRefreshAdmission(Priority.Background)
sut.propose(draft, target, listOf(COUNTERPARTY)).getOrThrow()
activity.checkRefreshAdmission(Priority.Background)
verify(paykitSdkService, times(2)).proposePaymentRequest(any(), any(), eq(LOCAL_IDENTITY))
verify(paykitSdkService, never()).processPendingPrivateMessages()
}

@Test
fun `cancelled creation releases review during eligibility or delivery and permits another creation`() = test {
val activity = stubPaymentReview()
val record = paymentRequestRecord(role = PaymentRequestLocalRole.PAYEE).copy(proposalOutboundMessageId = 7uL)
val draft = PaykitPaymentRequestDraft(PaykitAmount(PaykitAsset.BTC, 1uL), "Lunch", clock.now().plus(60.seconds))
for (duringDelivery in listOf(false, true)) {
var block = true
val target = stubProposal(record)
if (duringDelivery) {
whenever(paykitSdkService.processOutboundPrivateMessages(COUNTERPARTY)).doSuspendableAnswer {
if (block) awaitCancellation()
OutboundPrivateSendReport(emptyList(), emptyList(), emptyList(), emptyList(), emptyList())
}
} else {
whenever(paykitSdkService.identityStatus()).doSuspendableAnswer {
if (block) awaitCancellation()
IdentityStatus(LOCAL_IDENTITY, PubkyIdentityCapability.PRIVATE_LINK_CAPABLE)
}
}
val proposal = async { sut.propose(draft, target, listOf(COUNTERPARTY)).getOrThrow() }
runCurrent()
assertFailsWith<PaykitPaymentRequestError.OperationInProgress> {
activity.checkRefreshAdmission(Priority.Background)
}
proposal.cancel()
assertFailsWith<CancellationException> { proposal.await() }
proposal.join()
assertFalse(sut.isCreatingRequest.value)
activity.checkRefreshAdmission(Priority.Background)

block = false
stubProposal(record)
sut.propose(draft, target, listOf(COUNTERPARTY)).getOrThrow()
activity.checkRefreshAdmission(Priority.Background)
}
}

@Test
fun `creation releases review when fresh eligibility rejects the target`() = test {
val activity = stubPaymentReview()
val record = paymentRequestRecord(role = PaymentRequestLocalRole.PAYEE)
val target = stubProposal(record)
val draft = PaykitPaymentRequestDraft(PaykitAmount(PaykitAsset.BTC, 1uL), "Lunch", clock.now().plus(60.seconds))
whenever(paykitSdkService.identityStatus()).doSuspendableAnswer {
assertFailsWith<PaykitPaymentRequestError.OperationInProgress> {
activity.checkRefreshAdmission(Priority.Background)
}
IdentityStatus(SECOND_IDENTITY, PubkyIdentityCapability.PRIVATE_LINK_CAPABLE)
}
assertSame(
PaykitPaymentRequestError.RequestUnavailable,
sut.propose(draft, target, listOf(COUNTERPARTY)).exceptionOrNull(),
)
assertFalse(sut.isCreatingRequest.value)
activity.checkRefreshAdmission(Priority.Background)
verify(paykitSdkService, never()).proposePaymentRequest(any(), any(), any())
doReturn(IdentityStatus(LOCAL_IDENTITY, PubkyIdentityCapability.PRIVATE_LINK_CAPABLE))
.whenever(paykitSdkService).identityStatus()
stubProposal(record)
sut.propose(draft, target, listOf(COUNTERPARTY)).getOrThrow()
activity.checkRefreshAdmission(Priority.Background)
}

@Test
fun `proposal uses canonical terms and accepts available selected methods`() = test {
val target =
Expand Down Expand Up @@ -2382,6 +2498,7 @@ class PaykitPaymentRequestRepoTest : BaseUnitTest(StandardTestDispatcher()) {

@Test
fun `proposal skips status lookup only after its durable send failure`() = test {
val activity = stubPaymentReview()
val record = paymentRequestRecord(role = PaymentRequestLocalRole.PAYEE).copy(proposalOutboundMessageId = 7uL)
val target = stubProposal(record)
val error = mock<PrivateOperationError> {
Expand Down Expand Up @@ -2409,6 +2526,8 @@ class PaykitPaymentRequestRepoTest : BaseUnitTest(StandardTestDispatcher()) {
listOf(COUNTERPARTY),
).getOrThrow()

activity.checkRefreshAdmission(Priority.Background)
assertFalse(sut.isCreatingRequest.value)
val expected = if (failedMessageId == 7uL) {
PaykitPaymentRequestDeliveryStatus.Queued
} else {
Expand All @@ -2421,6 +2540,7 @@ class PaykitPaymentRequestRepoTest : BaseUnitTest(StandardTestDispatcher()) {

@Test
fun `proposal remains created after status read failure and propagates status read cancellation`() = test {
val activity = stubPaymentReview()
val record = paymentRequestRecord(role = PaymentRequestLocalRole.PAYEE).copy(proposalOutboundMessageId = 7uL)
val target = stubProposal(record)
val draft = PaykitPaymentRequestDraft(PaykitAmount(PaykitAsset.BTC, 1uL), "Lunch", clock.now().plus(60.seconds))
Expand All @@ -2434,10 +2554,12 @@ class PaykitPaymentRequestRepoTest : BaseUnitTest(StandardTestDispatcher()) {

assertEquals(PaykitPaymentRequestDeliveryStatus.Queued, creation.request.deliveryStatus)
assertEquals(listOf(creation.request), sut.paymentRequestHistory.value)
activity.checkRefreshAdmission(Priority.Background)
cancelled = true
assertFailsWith<CancellationException> { sut.propose(draft, target, listOf(COUNTERPARTY)) }
verify(paykitSdkService, times(2)).proposePaymentRequest(any(), any(), eq(LOCAL_IDENTITY))
assertFalse(sut.isCreatingRequest.value)
activity.checkRefreshAdmission(Priority.Background)
}

@Test
Expand Down Expand Up @@ -2516,6 +2638,7 @@ class PaykitPaymentRequestRepoTest : BaseUnitTest(StandardTestDispatcher()) {

@Test
fun `identity switch keeps a committed proposal out of the replacement identity state`() = test {
val activity = stubPaymentReview()
val target = PaykitPaymentRequestTarget(COUNTERPARTY)
val proposalStarted = CompletableDeferred<Unit>()
val finishProposal = CompletableDeferred<Unit>()
Expand Down Expand Up @@ -2547,12 +2670,17 @@ class PaykitPaymentRequestRepoTest : BaseUnitTest(StandardTestDispatcher()) {
).getOrThrow()
}
proposalStarted.await()
assertFailsWith<PaykitPaymentRequestError.OperationInProgress> {
activity.checkRefreshAdmission(Priority.Background)
}
val activation = async { sut.activate(SECOND_IDENTITY) }
runCurrent()
finishProposal.complete(Unit)

val creation = proposal.await()
activation.await()
activity.checkRefreshAdmission(Priority.Background)
assertFalse(sut.isCreatingRequest.value)

assertEquals(LOCAL_IDENTITY, creation.creatorIdentity)
assertFalse(creation.wasPublishedToActiveState)
Expand Down Expand Up @@ -3130,6 +3258,12 @@ class PaykitPaymentRequestRepoTest : BaseUnitTest(StandardTestDispatcher()) {
assertTrue(!sut.isPending(request))
}

private fun stubPaymentReview(): PaykitSdkService {
val activity = PaykitSdkService(mock(), mock(), mock(), settingsStore = mock()) { mock() }
doAnswer { activity.beginPaymentReview() }.whenever(paykitSdkService).beginPaymentReview()
return activity
}

private suspend fun stubProposal(record: PaymentRequestRecord): PaykitPaymentRequestTarget {
whenever(paykitSdkService.identityStatus()).thenReturn(
IdentityStatus(LOCAL_IDENTITY, PubkyIdentityCapability.PRIVATE_LINK_CAPABLE),
Expand Down
Loading