File size: 60,673 Bytes
b8370f5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 | import Foundation
import OpenClawKit
import OSLog
private let outboxLogger = Logger(subsystem: "ai.openclaw", category: "OpenClawChatOutbox")
/// Display state for a transcript row backed by a durable outbox command.
public enum OpenClawChatOutboxMessageState: Equatable, Sendable {
case queued
case sending
case confirming
case failed(reason: String?)
public var isFailed: Bool {
if case .failed = self { return true }
return false
}
var preventsDeletion: Bool {
self == .sending || self == .confirming
}
}
/// Durable offline command outbox. Sends made while the gateway is unhealthy
/// are persisted in installation-wide client state and flushed
/// strictly in createdAt order when health recovers. A gateway ACK only moves
/// a row to awaiting-confirmation; canonical history owns durable completion.
extension OpenClawChatViewModel {
/// True when this view model owns a gateway-scoped durable text outbox.
public var supportsOfflineTextOutbox: Bool {
self.outbox != nil
}
struct OutboxDeliveryTarget: Hashable {
let presentationSessionKey: String
let deliverySessionKey: String
let agentID: String?
}
private enum OutboxFlushDisposition {
case continueFlush
case continueAndReconcile(OutboxDeliveryTarget)
case stop
case stopAndReconcile(OutboxDeliveryTarget)
}
public func outboxState(for messageID: UUID) -> OpenClawChatOutboxMessageState? {
self.outboxStatesByMessageID[messageID]
}
static func activeBranchLeafEntryID(in branches: [OpenClawChatSessionBranch]) -> String? {
let active = branches.filter(\.active)
guard active.count == 1 else { return nil }
let leaf = active[0].leafEntryId.trimmingCharacters(in: .whitespacesAndNewlines)
return leaf.isEmpty ? nil : leaf
}
/// Marks a sessions.branches.list rejection decided from the hello method
/// catalog, without a network call. Released 2026.7.x gateways authorize
/// before dispatch and reject unknown methods with "missing scope:
/// operator.admin" — an error that never names the method, so text
/// matching alone can never detect them.
struct BranchListingUnadvertisedError: Error {}
static func branchListingIsUnsupported(_ error: Error) -> Bool {
if error is BranchListingUnadvertisedError { return true }
// GatewayResponseError bridges through errorDescription, which always
// prefixes the method name; the qualifier words decide. A genuine scope
// denial ("missing scope: ...") matches none, keeping queued work parked.
let message = (error as NSError).localizedDescription.lowercased()
return message.contains("sessions.branches.list") &&
(message.contains("not supported") || message.contains("unsupported") ||
message.contains("unimplemented") || message.contains("unknown method"))
}
/// Single dispatch point for sessions.branches.list: the hello catalog is
/// consulted first so paired clients never poll gateways that predate the
/// method (see BranchListingUnadvertisedError); nil catalog still calls.
func requestSessionBranchListing(
sessionKey: String,
agentID: String?) async throws -> OpenClawChatSessionBranchesResponse
{
if await self.transport.gatewayAdvertisesMethod("sessions.branches.list") == false {
throw Self.BranchListingUnadvertisedError()
}
return try await self.transport.listSessionBranches(sessionKey: sessionKey, agentID: agentID)
}
func outboxBranchScope(for session: SessionSnapshot) -> OpenClawChatOutboxScope? {
let agentID = self.outboxAgentID(for: session)
guard !self.outboxRequiresAgentID(for: session) || agentID != nil else { return nil }
return OpenClawChatOutboxScope(sessionKey: session.key, agentID: agentID)
}
private static func outboxBranchScope(for command: OpenClawChatOutboxCommand) -> OpenClawChatOutboxScope {
OpenClawChatOutboxScope(sessionKey: command.sessionKey, agentID: command.agentID)
}
var hasPendingOutboxCommandsForCurrentSession: Bool {
self
.outbox != nil &&
(!self.hasRestoredOutboxMessages || self.outboxStatesByMessageID.values.contains { !$0.isFailed })
}
var hasUnresolvedOutboxCommandsForCurrentSession: Bool {
self.outbox != nil && (!self.hasRestoredOutboxMessages || !self.outboxStatesByMessageID.isEmpty)
}
func beginOutboxSessionMutation(_ session: SessionSnapshot) async -> Bool {
guard let outbox, let scope = self.outboxBranchScope(for: session) else { return self.outbox == nil }
await self.pendingCacheWriteTask?.value
return await outbox.beginBranchSwitch(scope)
}
func cancelOutboxSessionMutation(_ session: SessionSnapshot) async {
guard let outbox, let scope = self.outboxBranchScope(for: session) else { return }
_ = await outbox.cancelBranchSwitch(scope)
}
func recoverOutboxAfterSessionMutationRefreshFailure(
_ session: SessionSnapshot,
branchingUnsupported: Bool) async
{
self.pauseOutboxBranchScope(session)
if let outbox = self.outbox, let scope = self.outboxBranchScope(for: session) {
_ = await outbox.demoteBranchSwitchToReconcile(scope)
}
if branchingUnsupported {
self.allowOutboxReplayWithoutBranching(session)
} else {
self.reconcilePendingOutboxBranchScopes()
}
}
func confirmOutboxBranchChange(_ session: SessionSnapshot, activeLeafEntryID: String) async -> Bool {
guard let outbox, let scope = self.outboxBranchScope(for: session) else { return self.outbox == nil }
self.reconciledOutboxBranchScopes.remove(scope)
await self.pendingCacheWriteTask?.value
guard let commands = await outbox.confirmBranchChange(
scope,
activeLeafEntryID: activeLeafEntryID,
lastError: "Session branch changed; review and retry this message.")
else { return false }
self.reconciledOutboxBranchScopes.insert(scope)
guard self.isCurrentSession(session) else { return true }
self.presentOutboxCommands(commands.filter { self.commandMatchesTarget($0, session: session) })
return true
}
func pauseOutboxBranchScope(_ session: SessionSnapshot) {
guard let scope = self.outboxBranchScope(for: session) else { return }
self.reconciledOutboxBranchScopes.remove(scope)
}
func captureOutboxBranchState(for session: SessionSnapshot) async -> OpenClawChatOutboxBranchState? {
guard let outbox, let scope = self.outboxBranchScope(for: session) else { return nil }
await self.pendingCacheWriteTask?.value
return await outbox.branchState(for: scope)
}
private func waitForBootstrapOutboxBranchCapture(for session: SessionSnapshot) async {
guard let capture = self.bootstrapOutboxBranchStateCapture, capture.session == session else { return }
_ = await capture.task.value
}
func observeOutboxTranscriptTip(_ message: OpenClawChatMessage, session: SessionSnapshot) {
guard let outbox, let scope = self.outboxBranchScope(for: session),
let tip = message.transcriptMessageID?.trimmingCharacters(in: .whitespacesAndNewlines), !tip.isEmpty
else { return }
let state = Task { await outbox.branchState(for: scope) }
let previous = self.pendingCacheWriteTask
self.pendingCacheWriteTask = Task.detached {
await previous?.value
guard let epoch = await state.value?.epoch else { return }
_ = await outbox.updateLastActiveLeafEntryID(tip, expectedEpoch: epoch, for: scope)
}
}
@discardableResult
func reconcileOutboxBranchScope(
_ session: SessionSnapshot,
branches: [OpenClawChatSessionBranch],
previousState: OpenClawChatOutboxBranchState?,
connectionGeneration: UInt64) async -> Bool
{
guard let outbox, let scope = self.outboxBranchScope(for: session), let previousState,
connectionGeneration == self.outboxBranchConnectionGeneration
else { return self.outbox == nil }
let activeLeaf: String? = branches.isEmpty ? nil : Self.activeBranchLeafEntryID(in: branches)
guard branches.isEmpty || activeLeaf != nil else { return false }
let leaves = Set(branches.map(\.leafEntryId).filter { !$0.isEmpty })
let activeTranscriptEntryIDs = self.isCurrentSession(session)
? Set(self.messages.compactMap(\.transcriptMessageID))
: []
guard let commands = await outbox.reconcileBranchScope(
scope,
previousState: previousState,
activeLeafEntryID: activeLeaf,
branchLeafEntryIDs: leaves,
activeTranscriptEntryIDs: activeTranscriptEntryIDs,
lastError: "Session branch changed; review and retry this message.")
else { return false }
self.reconciledOutboxBranchScopes.insert(scope)
if self.isCurrentSession(session) {
self.presentOutboxCommands(commands.filter { self.commandMatchesTarget($0, session: session) })
}
return true
}
func allowOutboxReplayWithoutBranching(_ session: SessionSnapshot) {
guard let scope = self.outboxBranchScope(for: session) else { return }
self.reconciledOutboxBranchScopes.insert(scope)
self.flushOutboxIfNeeded()
}
func reconcilePendingOutboxBranchScopes() {
guard let outbox, self.healthOK else { return }
Task { [weak self] in
guard let self, let commands = await outbox.loadCommandsIfAvailable() else { return }
let grouped = Dictionary(grouping: commands.filter {
$0.status == .queued || $0.status == .sending || $0.status == .awaitingConfirmation
}, by: Self.outboxBranchScope(for:))
for (scope, scopedCommands) in grouped where !self.reconciledOutboxBranchScopes.contains(scope) {
guard let command = scopedCommands.first,
let state = await outbox.branchState(for: scope)
else { continue }
do {
let response = try await self.requestSessionBranchListing(
sessionKey: command.deliverySessionKey,
agentID: command.agentID)
let activeLeaf: String? = response.branches.isEmpty ? nil : Self
.activeBranchLeafEntryID(in: response.branches)
guard response.branches.isEmpty || activeLeaf != nil else { continue }
let leaves = Set(response.branches.map(\.leafEntryId).filter { !$0.isEmpty })
let activeTranscriptEntryIDs = self.outboxBranchScope(for: self.currentSessionSnapshot()) == scope
? Set(self.messages.compactMap(\.transcriptMessageID))
: []
guard let reconciled = await outbox.reconcileBranchScope(
scope,
previousState: state,
activeLeafEntryID: activeLeaf,
branchLeafEntryIDs: leaves,
activeTranscriptEntryIDs: activeTranscriptEntryIDs,
lastError: "Session branch changed; review and retry this message.")
else { continue }
self.reconciledOutboxBranchScopes.insert(scope)
let visible = self.currentSessionSnapshot()
if self.outboxBranchScope(for: visible) == scope {
self
.presentOutboxCommands(reconciled
.filter { self.commandMatchesTarget($0, session: visible) })
}
} catch {
if Self.branchListingIsUnsupported(error) {
self.reconciledOutboxBranchScopes.insert(scope)
}
}
}
self.flushOutboxIfNeeded()
}
}
func invalidateOutboxBranchReconciliation() {
self.outboxBranchConnectionGeneration &+= 1
self.reconciledOutboxBranchScopes.removeAll()
self.reconcilingOutboxBranchScopes.removeAll()
for task in self.outboxBranchReconcileRetryTasks.values {
task.cancel()
}
self.outboxBranchReconcileRetryTasks.removeAll()
self.outboxBranchReconcileRetryAttempts.removeAll()
}
/// Tap-to-retry for a failed command: reset attempts, refresh createdAt
/// (so even an expired row can send again), and flush if healthy.
public func retryOutboxMessage(_ messageID: UUID) {
guard !self.isSwitchingSessionBranch,
let outbox,
let commandID = self.outboxCommandIDsByMessageID[messageID],
let failure = self.outboxFailureVersionsByMessageID[messageID]
else { return }
let session = self.currentSessionSnapshot()
Task { [weak self] in
guard let self else { return }
let agentID = self.outboxAgentID(for: session)
if self.outboxRequiresAgentID(for: session), agentID == nil {
self.errorText = "Select an agent before retrying this message."
return
}
guard
let deliverySessionKey = self.outboxDeliverySessionKey(for: session, agentID: agentID),
let routingContract = self.outboxRoutingContract(for: session)
else {
self.errorText = "Reconnect to verify this message's delivery target before retrying."
return
}
let expectedSessionSettings = self.durableSessionSettingsExpectation()
let result = await outbox.markCommandRetriedIfPresent(
id: commandID,
expectation: OpenClawChatOutboxRetryExpectation(
attemptVersion: failure.attemptVersion,
retryCount: failure.retryCount,
lastError: failure.lastError),
agentID: agentID,
deliverySessionKey: deliverySessionKey,
routingContract: routingContract,
expectedSessionSettings: expectedSessionSettings,
replacementID: UUID().uuidString)
if result == .updated {
// Durable work is gateway-global. Flush even when the visible
// session changed while the SQLite update was suspended.
self.flushOutboxIfNeeded()
}
guard self.isCurrentSession(session) else { return }
switch result {
case .updated:
self.outboxStatesByMessageID[messageID] = .queued
self.outboxFailureVersionsByMessageID.removeValue(forKey: messageID)
case .missing, .confirmed, .superseded:
self.clearOutboxState(forCommandID: commandID)
case .unavailable:
self.errorText = "Could not retry the queued message. Try again."
}
}
}
public func deleteOutboxMessage(_ messageID: UUID) {
guard let outbox, let commandID = self.outboxCommandIDsByMessageID[messageID] else { return }
self.cancelingOutboxCommandIDs.insert(commandID)
self.outboxPresentationGeneration &+= 1
Task { [weak self] in
guard let self else { return }
let result = await outbox.cancelCommand(id: commandID)
guard result != .unavailable else {
self.finishOutboxCancellation(commandID)
self.errorText = "Could not delete the queued message. Try again."
return
}
if result == .confirmed {
self.finishOutboxCancellation(commandID)
self.clearOutboxState(forCommandID: commandID)
return
}
if result == .missing {
let presentationGeneration = self.outboxPresentationGeneration
let current = await outbox.loadCommands().first(where: { $0.id == commandID })
guard presentationGeneration == self.outboxPresentationGeneration else {
self.finishOutboxCancellation(commandID)
return
}
if let current {
// Another view model claimed the row first. Keep the bubble
// and show its authoritative state; cancellation after claim
// would promise deletion while the request can still land.
self.finishOutboxCancellation(commandID)
self.presentOutboxCommands([current])
return
}
}
if self.canonicalOutboxMessageKeys.contains("\(commandID):user") {
self.finishOutboxCancellation(commandID)
self.clearOutboxState(forCommandID: commandID)
return
}
self.finishOutboxCancellation(commandID)
self.outboxCommandIDsByMessageID.removeValue(forKey: messageID)
self.outboxMessageIDsByCommandID.removeValue(forKey: commandID)
self.outboxStatesByMessageID.removeValue(forKey: messageID)
// `.missing` with no current row means another view already
// canceled (or canonical history completed) this mapping. Never
// leave its stale bubble looking like an ordinary sent message;
// canonical history can re-add a genuinely delivered row.
self.replaceMessages(self.messages.filter { $0.id != messageID })
}
}
// MARK: - Capture
/// Durable capture path used before text or attachment delivery: persist
/// first, then render the queued bubble. A full queue refuses the enqueue
/// and keeps the exact draft intact.
@discardableResult
func enqueueOutboxCommand(
text: String,
draftInput: String,
draftRevision: UInt64,
draftAttachments: [OpenClawPendingAttachment] = [],
session: SessionSnapshot) async -> Bool
{
guard let outbox else { return false }
let agentID = self.outboxAgentID(for: session)
if self.outboxRequiresAgentID(for: session), agentID == nil {
self.errorText = "Select an agent before queueing this message."
return false
}
guard
let deliverySessionKey = self.outboxDeliverySessionKey(for: session, agentID: agentID),
let routingContract = self.outboxRoutingContract(for: session)
else {
self.errorText = "Reconnect to verify this message's delivery target before queueing."
return false
}
// Capture the effective value only after model selection settles. Raw
// preferences can outlive this process, when model metadata is absent.
if let settingsError = await self.waitForCapabilitySettingsBarrier(
in: session.key,
canonicalSessionKey: deliverySessionKey,
agentID: agentID,
sessionRoutingContract: routingContract)
{
self.errorText = settingsError
return false
}
guard self.isCurrentSession(session) else { return false }
let expectedSessionSettings = self.durableSessionSettingsExpectation()
let thinking = self.effectiveThinkingLevelForSend(
self.preferredThinkingLevel,
sessionKey: session.key,
canonicalSessionKey: deliverySessionKey,
agentID: agentID,
sessionRoutingContract: routingContract)
let command = OpenClawChatOutboxCommand(
id: UUID().uuidString,
sessionKey: session.key,
deliverySessionKey: deliverySessionKey,
routingContract: routingContract,
agentID: agentID,
text: text,
attachments: draftAttachments.map {
OpenClawChatOutboxAttachment(
type: $0.type,
mimeType: $0.mimeType,
fileName: $0.fileName,
data: $0.data,
durationSeconds: $0.durationSeconds)
},
thinking: thinking,
expectedSessionSettings: expectedSessionSettings,
createdAt: Date().timeIntervalSince1970,
status: .queued,
retryCount: 0,
lastError: nil)
await self.waitForBootstrapOutboxBranchCapture(for: session)
let accepted = await outbox.enqueueCommand(command)
guard accepted else {
if self.isCurrentSession(session) {
self.errorText = "Offline queue is full. Delete a queued message or reconnect to send."
}
return false
}
// Acceptance is durable even if the user switched sessions during the
// await. The caller must still retire that session's draft/history.
// Bubble render and flush scheduling stay with the displayed session
// (shipped behavior predating this path); the stored command delivers
// on the next flush trigger, e.g. returning here or a health event.
guard self.isCurrentSession(session) else { return true }
if self.input == draftInput, self.composerRevision(for: session.key) == draftRevision {
self.input = ""
}
let capturedAttachmentIDs = Set(draftAttachments.map(\.id))
self.attachments.removeAll { capturedAttachmentIDs.contains($0.id) }
self.errorText = nil
self.presentOutboxCommands([command])
// Health can recover between the send-gate check and the enqueue;
// flushing here closes that gap instead of waiting for the next event.
if self.healthOK {
self.flushOutboxIfNeeded()
}
return true
}
/// Durable path for a failed live text send. Known pre-dispatch route
/// changes remain queued; ambiguous results fail closed until canonical
/// history or explicit retry resolves them.
/// Returns false when the queue refuses (caller keeps the failure path).
func preserveFailedLiveSend(
runId: String,
text: String,
thinking: String,
messageID: UUID,
session: SessionSnapshot,
expectedSessionSettings: OpenClawChatSessionSettingsExpectation,
deliveryIsAmbiguous: Bool) async -> Bool
{
guard let outbox else { return false }
let agentID = self.outboxAgentID(for: session)
guard !self.outboxRequiresAgentID(for: session) || agentID != nil,
let deliverySessionKey = self.outboxDeliverySessionKey(for: session, agentID: agentID),
let routingContract = self.outboxRoutingContract(for: session)
else { return false }
let command = OpenClawChatOutboxCommand(
id: runId,
sessionKey: session.key,
deliverySessionKey: deliverySessionKey,
routingContract: routingContract,
agentID: agentID,
text: text,
thinking: thinking,
expectedSessionSettings: expectedSessionSettings,
createdAt: Date().timeIntervalSince1970,
status: deliveryIsAmbiguous ? .failed : .queued,
retryCount: 0,
lastError: deliveryIsAmbiguous
? OpenClawChatSQLiteTranscriptCache.outboxUnconfirmedError
: nil)
await self.waitForBootstrapOutboxBranchCapture(for: session)
guard await outbox.enqueueCommand(command) else { return false }
guard self.isCurrentSession(session) else { return true }
self.mapOutboxCommand(command, to: messageID)
self.errorText = nil
// Ambiguous rows only reconcile history; known-unsent rows may flush
// automatically once the replacement route becomes healthy.
self.flushOutboxIfNeeded()
return true
}
// MARK: - Restore
/// Session switches drop the visible bubbles, so per-message outbox
/// state must go with them, and the FIFO send gate must assume a backlog
/// again until restore adopts the new session's durable rows. Without
/// this reset a send issued right after a switch could go live ahead of
/// that session's persisted queue.
func resetOutboxPresentationForSessionSwitch() {
self.hasRestoredOutboxMessages = false
self.outboxCommandIDsByMessageID.removeAll()
self.outboxMessageIDsByCommandID.removeAll()
self.outboxStatesByMessageID.removeAll()
self.outboxFailureVersionsByMessageID.removeAll()
}
/// Re-adopts or re-appends queued bubbles for the visible session after
/// cold open, session switches, and wholesale history replacement.
func restoreOutboxMessages(session: SessionSnapshot) {
guard let outbox else { return }
Task { [weak self] in
guard let self else { return }
guard await self.recoverInterruptedOutboxSendsIfNeeded() else { return }
while self.isCurrentSession(session) {
let presentationGeneration = self.outboxPresentationGeneration
guard let commands = await outbox.loadCommandsIfAvailable() else { return }
guard self.isCurrentSession(session) else { return }
if presentationGeneration != self.outboxPresentationGeneration {
// A cross-view cancellation/confirmation invalidated this
// snapshot. Reload so unrelated surviving rows still paint.
continue
}
self.presentOutboxCommands(commands.filter { self.commandMatchesTarget($0, session: session) })
// The FIFO send gate assumes a backlog until this point.
self.hasRestoredOutboxMessages = true
// Relaunching while already healthy never sees an unhealthy ->
// healthy transition, so kick the flush here as well.
if self.healthOK, commands.contains(where: { $0.status == .queued }) {
self.reconcilePendingOutboxBranchScopes()
}
return
}
}
}
/// Canonical history is the durable acceptance boundary. Any matching
/// outbox row—including a delivery-unconfirmed row—is now safe to remove
/// without replaying the user turn.
func confirmOutboxCommands(in messages: [OpenClawChatMessage]) {
self.observeCanonicalOutboxMessageKeys(in: messages)
Task { [weak self] in
await self?.confirmOutboxCommandsNow(in: messages)
}
}
func confirmOutboxCommandsNow(in messages: [OpenClawChatMessage]) async {
self.observeCanonicalOutboxMessageKeys(in: messages)
guard let outbox else { return }
let confirmedKeys = Set(messages.compactMap { Self.normalizedIdempotencyKey($0.idempotencyKey) })
guard !confirmedKeys.isEmpty else { return }
let commands = await outbox.loadCommands().filter { command in
// Command UUIDs are gateway-global. Match the durable identity,
// not a presentation alias (`main` vs `agent:<id>:main`).
confirmedKeys.contains(Self.outboxUserIdempotencyKey(command.id))
}
for command in commands {
if let canonicalMessage = messages.first(where: {
Self.normalizedIdempotencyKey($0.idempotencyKey) ==
Self.outboxUserIdempotencyKey(command.id)
}) {
await self.persistCanonicalOutboxEvidence(canonicalMessage, for: command)
}
let result = await outbox.confirmCommand(id: command.id, attemptVersion: command.attemptVersion)
if result == .updated || result == .confirmed {
self.clearOutboxState(forCommandID: command.id)
}
}
}
private func persistCanonicalOutboxEvidence(
_ message: OpenClawChatMessage,
for command: OpenClawChatOutboxCommand) async
{
guard let transcriptCache = transcriptCache as? any OpenClawChatCanonicalTranscriptMerging else { return }
let sessionKey = command.sessionKey
let cacheAgentID = Self.transcriptCacheAgentID(
sessionKey: sessionKey,
agentID: command.agentID)
let messageKey = Self.outboxUserIdempotencyKey(command.id)
let canonicalMessage = Self.adoptingCanonicalMessage(
message,
over: Self.outboxUserMessage(for: command))
let previous = self.pendingCacheWriteTask
let task = Task.detached {
await previous?.value
await transcriptCache.mergeCanonicalTranscriptMessage(
sessionKey: sessionKey,
agentID: cacheAgentID,
message: canonicalMessage,
canonicalMessageIdempotencyKey: messageKey)
}
self.pendingCacheWriteTask = task
await task.value
}
private func observeCanonicalOutboxMessageKeys(in messages: [OpenClawChatMessage]) {
let keys = Set(messages.compactMap(\.idempotencyKey))
for key in keys.sorted() {
self.canonicalOutboxMessageKeys.removeAll(where: { $0 == key })
self.canonicalOutboxMessageKeys.append(key)
}
if self.canonicalOutboxMessageKeys.count > 512 {
self.canonicalOutboxMessageKeys.removeFirst(self.canonicalOutboxMessageKeys.count - 512)
}
self.transcriptCache?.observeCanonicalMessageIdempotencyKeys(keys)
}
/// Appends bubbles for commands in the current session, adopting rows
/// that already carry the command's user idempotency key from an earlier
/// restore, and refreshes their display states.
private func presentOutboxCommands(_ commands: [OpenClawChatOutboxCommand]) {
self.pruneOutboxMappings()
guard !commands.isEmpty else { return }
var next = self.messages
for command in commands.sorted(by: { $0.createdAt < $1.createdAt }) {
if self.cancelingOutboxCommandIDs.contains(command.id) { continue }
let key = Self.outboxUserIdempotencyKey(command.id)
if let existing = next.first(where: { $0.idempotencyKey == key }) {
self.mapOutboxCommand(command, to: existing.id)
continue
}
let message = Self.outboxUserMessage(for: command)
next.append(message)
self.mapOutboxCommand(command, to: message.id)
}
self.replaceMessages(next)
}
private static func outboxUserMessage(for command: OpenClawChatOutboxCommand) -> OpenClawChatMessage {
var content = [
OpenClawChatMessageContent(
type: "text",
text: command.text,
mimeType: nil,
fileName: nil,
content: nil),
]
content.append(contentsOf: command.attachments.map { attachment in
OpenClawChatMessageContent(
type: attachment.type,
text: nil,
mimeType: attachment.mimeType,
fileName: attachment.fileName,
durationSeconds: attachment.durationSeconds,
content: AnyCodable(attachment.data.base64EncodedString()))
})
return OpenClawChatMessage(
role: "user",
content: content,
// Message timestamps are milliseconds; outbox rows store seconds.
timestamp: command.createdAt * 1000,
idempotencyKey: self.outboxUserIdempotencyKey(command.id))
}
private func mapOutboxCommand(_ command: OpenClawChatOutboxCommand, to messageID: UUID) {
self.outboxCommandIDsByMessageID[messageID] = command.id
self.outboxMessageIDsByCommandID[command.id] = messageID
self.outboxStatesByMessageID[messageID] = Self.outboxDisplayState(for: command)
if command.status == .failed {
self.outboxFailureVersionsByMessageID[messageID] = (
command.attemptVersion, command.retryCount, command.lastError)
} else {
self.outboxFailureVersionsByMessageID.removeValue(forKey: messageID)
}
}
private func pruneOutboxMappings() {
let visibleMessageIDs = Set(self.messages.map(\.id))
let staleMessageIDs = self.outboxCommandIDsByMessageID.keys.filter {
!visibleMessageIDs.contains($0)
}
for messageID in staleMessageIDs {
if let commandID = self.outboxCommandIDsByMessageID.removeValue(forKey: messageID) {
self.outboxMessageIDsByCommandID.removeValue(forKey: commandID)
}
self.outboxStatesByMessageID.removeValue(forKey: messageID)
self.outboxFailureVersionsByMessageID.removeValue(forKey: messageID)
}
}
// MARK: - Health
func pollHealthIfNeeded(
force: Bool,
sessionSnapshot: SessionSnapshot? = nil,
refreshSessionsOnReconnect: Bool = true) async
{
if !force, let last = lastHealthPollAt, Date().timeIntervalSince(last) < 10 {
return
}
self.lastHealthPollAt = Date()
do {
let ok = try await self.transport.requestHealth(timeoutMs: 5000)
if let sessionSnapshot, !self.isCurrentSession(sessionSnapshot) { return }
self.applyTransportHealth(ok, refreshSessionsOnReconnect: refreshSessionsOnReconnect)
} catch {
if let sessionSnapshot, !self.isCurrentSession(sessionSnapshot) { return }
self.applyTransportHealth(false)
}
}
/// Single choke point for health updates so the offline outbox flushes
/// exactly on the unhealthy -> healthy transition.
func applyTransportHealth(_ ok: Bool, refreshSessionsOnReconnect: Bool = true) {
let wasHealthy = self.healthOK
self.healthOK = ok
if !ok, wasHealthy || self.hasCurrentSessionMetadata {
self.invalidateSessionMetadataReadiness()
}
if ok, !wasHealthy {
guard self.outbox != nil else { return }
if self.hasCurrentSessionMetadata {
self.reconcilePendingOutboxBranchScopes()
} else if refreshSessionsOnReconnect {
let session = self.currentSessionSnapshot()
Task { await self.fetchSessions(limit: 50, sessionSnapshot: session) }
}
}
}
// MARK: - Flush
func flushOutboxIfNeeded() {
guard self.outbox != nil, self.healthOK else { return }
// Health is intentionally established before sessions.list. Replays
// need the current connection's model/runtime metadata first.
guard self.hasCurrentSessionMetadata else { return }
guard !self.isFlushingOutbox else {
// Coalesce triggers that land mid-pass (tap-to-retry, enqueue
// race) so their commands are not stranded until the next
// health transition.
self.isOutboxFlushRequestedWhileActive = true
return
}
self.isFlushingOutbox = true
Task { [weak self] in
await self?.performOutboxFlush()
guard let self else { return }
self.isFlushingOutbox = false
if self.isOutboxFlushRequestedWhileActive {
self.isOutboxFlushRequestedWhileActive = false
self.flushOutboxIfNeeded()
}
}
}
private func performOutboxFlush() async {
guard let outbox else { return }
let presentationGeneration = self.outboxPresentationGeneration
guard let initialCommands = await outbox.loadCommandsIfAvailable() else {
self.applyTransportHealth(false)
return
}
guard presentationGeneration == self.outboxPresentationGeneration else {
self.isOutboxFlushRequestedWhileActive = true
return
}
let visibleSession = self.currentSessionSnapshot()
self.presentOutboxCommands(initialCommands.filter { self.commandMatchesTarget($0, session: visibleSession) })
if initialCommands.contains(where: {
($0.status == .queued || $0.status == .sending || $0.status == .awaitingConfirmation) &&
!self.reconciledOutboxBranchScopes.contains(Self.outboxBranchScope(for: $0))
}) {
self.reconcilePendingOutboxBranchScopes()
return
}
// Do not capability-gate ordinary live chat when no durable work
// needs a replay lease (notably against older gateways).
let hasRouteWork = initialCommands.contains { command in
command.status == .queued ||
command.status == .sending ||
Self.needsOutboxDeliveryReconciliation(command)
}
guard hasRouteWork else { return }
let routeResult = await self.transport.acquireOutboxRouteLease()
guard case let .available(routeLease) = routeResult else {
// The store owner no longer matches the active gateway route.
// Leave every row queued; the replacement view model owns the
// new gateway and a later matching reconnect can resume this one.
if case let .unavailable(reason, _) = routeResult, let reason {
self.errorText = reason
}
self.applyTransportHealth(false)
return
}
guard await self.recoverInterruptedOutboxSendsIfNeeded() else {
self.applyTransportHealth(false)
return
}
var confirmationTargets: Set<OutboxDeliveryTarget> = []
flushLoop: while self.healthOK {
let presentationGeneration = self.outboxPresentationGeneration
let commands = await outbox.loadCommands()
if presentationGeneration != self.outboxPresentationGeneration {
continue
}
confirmationTargets.formUnion(
commands.lazy
.filter(Self.needsOutboxDeliveryReconciliation)
.map(Self.deliveryTarget))
let visibleSession = self.currentSessionSnapshot()
self.presentOutboxCommands(commands.filter { self.commandMatchesTarget($0, session: visibleSession) })
guard let next = await outbox.claimNextCommand() else { break }
let scope = Self.outboxBranchScope(for: next)
guard self.reconciledOutboxBranchScopes.contains(scope) else {
_ = await outbox.markCommandQueued(
id: next.id,
attemptVersion: next.attemptVersion,
retryCount: next.retryCount,
lastError: nil)
break
}
guard next.branchEpoch == next.scopeBranchEpoch else {
_ = await self.failOutboxCommand(
next,
outbox: outbox,
retryCount: next.retryCount,
reason: "Session branch changed; review and retry this message.")
continue
}
if self.transport.outboxRequiresSessionRoutingContract,
next.routingContract != routeLease.sessionRoutingContract
{
guard await self.parkOutboxCommandForChangedTarget(next, outbox: outbox) else { break }
continue
}
switch await self.deliverOutboxCommand(next, outbox: outbox, routeLease: routeLease) {
case .continueFlush:
continue
case let .continueAndReconcile(target):
confirmationTargets.insert(target)
continue
case .stop:
break flushLoop
case let .stopAndReconcile(target):
confirmationTargets.insert(target)
break flushLoop
}
}
if !confirmationTargets.isEmpty {
await self.refreshHistoriesAfterOutboxFlush(
targets: confirmationTargets,
routeLease: routeLease)
}
}
private func deliverOutboxCommand(
_ command: OpenClawChatOutboxCommand,
outbox: any OpenClawChatCommandOutbox,
routeLease: OpenClawChatTransportRouteLease) async -> OutboxFlushDisposition
{
// A failed capability mutation must not release a queued message under
// the previous, broader authority. Return the claim to the queue until
// the operator successfully saves new settings or changes sessions.
if let settingsError = await self.waitForCapabilitySettingsBarrier(
in: command.sessionKey,
canonicalSessionKey: command.deliverySessionKey,
agentID: command.agentID,
sessionRoutingContract: command.routingContract)
{
_ = await self.failOutboxCommand(
command,
outbox: outbox,
retryCount: command.retryCount,
reason: settingsError)
self.errorText = settingsError
return .stop
}
if self.transport.outboxRequiresSessionRoutingContract,
!routeLease.supportsSessionSettingsCAS
{
let reason = OpenClawChatSQLiteTranscriptCache.outboxSettingsGatewayUpgradeRequiredError
let message = OpenClawChatSQLiteTranscriptCache.outboxDisplayError(reason)
let update = await self.failOutboxCommand(
command,
outbox: outbox,
retryCount: command.retryCount,
reason: reason)
self.errorText = message
return update == .unavailable ? .stop : .continueFlush
}
if routeLease.supportsSessionSettingsCAS,
command.expectedSessionSettings == nil
{
let reason = OpenClawChatSQLiteTranscriptCache.outboxSettingsReviewRequiredError
let message = OpenClawChatSQLiteTranscriptCache.outboxDisplayError(reason)
let update = await self.failOutboxCommand(
command,
outbox: outbox,
retryCount: command.retryCount,
reason: reason)
self.errorText = message
return update == .unavailable ? .stop : .continueFlush
}
self.setOutboxState(.sending, forCommandID: command.id)
do {
let response = try await routeLease.sendMessage(
sessionKey: command.deliverySessionKey,
agentID: command.agentID,
expectedSessionSettings: command.expectedSessionSettings,
message: command.text,
// Preserve the queued level when supported, but never send an
// explicit unsupported level after the gate changes.
thinking: self.effectiveThinkingLevelForSend(
command.thinking,
sessionKey: command.sessionKey,
canonicalSessionKey: command.deliverySessionKey,
agentID: command.agentID,
sessionRoutingContract: command.routingContract),
idempotencyKey: command.id,
attachments: command.attachments.map {
OpenClawChatAttachmentPayload(
type: $0.type,
mimeType: $0.mimeType,
fileName: $0.fileName,
content: $0.data.base64EncodedString())
})
if response.status == "error" || response.status == "timeout" {
// Gateway rejection consumes a retry attempt, unlike a
// transport failure that proved the request was not sent.
return await self.outboxRejectionDisposition(
command,
outbox: outbox,
reason: "Run failed to start (\(response.status)).")
}
return await self.finishAcceptedOutboxCommand(command, outbox: outbox)
} catch is OpenClawChatTransportSendError {
// The transport proved this payload never reached its request
// channel, so it is safe to retry automatically.
_ = await outbox.markCommandQueued(
id: command.id,
attemptVersion: command.attemptVersion,
retryCount: command.retryCount,
lastError: nil)
self.setOutboxState(.queued, forCommandID: command.id)
self.applyTransportHealth(false)
return .stop
} catch is CancellationError {
// Cancellation while the request is suspended does not prove that
// the gateway rejected it. Never replay automatically.
return await self.stopAfterUnconfirmedDelivery(command, outbox: outbox)
} catch let error as GatewayResponseError {
if error.detailsReason == OpenClawChatSessionRoutingContract.changedErrorReason {
let parked = await self.parkOutboxCommandForChangedTarget(command, outbox: outbox)
return parked ? .continueFlush : .stop
}
if error.detailsReason == OpenClawChatSessionSettingsContract.changedErrorReason {
let parked = await self.parkOutboxCommandForChangedSettings(command, outbox: outbox)
return parked ? .continueFlush : .stop
}
// A response error proves the gateway rejected the request; unlike
// a socket/timeout failure, replay cannot duplicate an accepted run.
return await self.outboxRejectionDisposition(
command,
outbox: outbox,
reason: error.localizedDescription)
} catch {
// A socket error or timeout is ambiguous: preserve the command for
// canonical-history reconciliation or explicit user retry.
outboxLogger.error("outbox flush send failed \(error.localizedDescription, privacy: .public)")
return await self.stopAfterUnconfirmedDelivery(command, outbox: outbox)
}
}
private func finishAcceptedOutboxCommand(
_ command: OpenClawChatOutboxCommand,
outbox: any OpenClawChatCommandOutbox) async -> OutboxFlushDisposition
{
// Deliberately no pendingRuns adoption for background flushes: the
// reply still lands via handleChatEvent's external-run final branch,
// handleSessionMessageEvent, and the post-drain history refresh. Run
// tracking (typing indicator, streaming, timeouts) stays owned by
// interactive performSend. chat.send ACK precedes durable user-turn
// persistence. The durable outbox remains the sole owner of the
// optimistic bubble until canonical history carries its key; writing
// it into the cache would require cross-database cancellation logic.
let update = await outbox.markCommandAwaitingConfirmation(
id: command.id,
attemptVersion: command.attemptVersion)
guard update != .unavailable else {
self.applyTransportHealth(false)
return .stop
}
if update == .updated {
self.setOutboxState(.confirming, forCommandID: command.id)
} else {
// A concurrent canonical history/session.message confirmation
// already removed the row.
self.clearOutboxState(forCommandID: command.id)
}
return .continueAndReconcile(Self.deliveryTarget(for: command))
}
private func outboxRejectionDisposition(
_ command: OpenClawChatOutboxCommand,
outbox: any OpenClawChatCommandOutbox,
reason: String) async -> OutboxFlushDisposition
{
let canContinue = await self.recordOutboxRejection(
of: command,
outbox: outbox,
reason: reason)
return canContinue ? .continueFlush : .stop
}
private func stopAfterUnconfirmedDelivery(
_ command: OpenClawChatOutboxCommand,
outbox: any OpenClawChatCommandOutbox) async -> OutboxFlushDisposition
{
let update = await self.failOutboxCommand(
command,
outbox: outbox,
retryCount: command.retryCount,
reason: OpenClawChatSQLiteTranscriptCache.outboxUnconfirmedError)
self.applyTransportHealth(false)
guard update == .updated else { return .stop }
return .stopAndReconcile(Self.deliveryTarget(for: command))
}
private static func needsOutboxDeliveryReconciliation(_ command: OpenClawChatOutboxCommand) -> Bool {
command.status == .awaitingConfirmation ||
(command.status == .failed &&
command.lastError == OpenClawChatSQLiteTranscriptCache.outboxUnconfirmedError)
}
private static func deliveryTarget(for command: OpenClawChatOutboxCommand) -> OutboxDeliveryTarget {
OutboxDeliveryTarget(
presentationSessionKey: command.sessionKey,
deliverySessionKey: command.deliverySessionKey,
agentID: command.agentID)
}
private func failOutboxCommand(
_ command: OpenClawChatOutboxCommand,
outbox: any OpenClawChatCommandOutbox,
retryCount: Int,
reason: String) async -> OpenClawChatOutboxUpdateResult
{
let update = await outbox.markCommandFailedIfPresent(
id: command.id,
attemptVersion: command.attemptVersion,
retryCount: retryCount,
lastError: reason)
switch update {
case .updated:
if let messageID = self.outboxMessageIDsByCommandID[command.id] {
// The retry action needs the same failed version as its badge;
// history may stay unavailable after this durable transition.
var failed = command
failed.status = .failed
failed.retryCount = retryCount
failed.lastError = reason
self.mapOutboxCommand(failed, to: messageID)
}
case .missing, .confirmed, .superseded:
self.clearOutboxState(forCommandID: command.id)
case .unavailable:
self.applyTransportHealth(false)
}
return update
}
private func parkOutboxCommandForChangedTarget(
_ command: OpenClawChatOutboxCommand,
outbox: any OpenClawChatCommandOutbox) async -> Bool
{
await self.failOutboxCommand(
command,
outbox: outbox,
retryCount: command.retryCount,
reason: OpenClawChatSQLiteTranscriptCache.outboxChangedTargetError) != .unavailable
}
private func parkOutboxCommandForChangedSettings(
_ command: OpenClawChatOutboxCommand,
outbox: any OpenClawChatCommandOutbox) async -> Bool
{
await self.failOutboxCommand(
command,
outbox: outbox,
retryCount: command.retryCount,
reason: OpenClawChatSQLiteTranscriptCache.outboxSettingsChangedError) != .unavailable
}
/// Gateway rejections ("error"/"timeout" send acks) burn a retry attempt
/// and become terminally 'failed' after `maxOutboxSendAttempts`. Returns
/// true when the flush pass may continue with younger commands.
private func recordOutboxRejection(
of command: OpenClawChatOutboxCommand,
outbox: any OpenClawChatCommandOutbox,
reason: String) async -> Bool
{
outboxLogger.error("outbox flush send rejected \(reason, privacy: .public)")
let attempts = command.retryCount + 1
if attempts >= Self.maxOutboxSendAttempts {
// Terminal failure needs user action; let younger commands
// flush instead of blocking behind it forever.
return await self.failOutboxCommand(
command,
outbox: outbox,
retryCount: attempts,
reason: reason) != .unavailable
}
_ = await outbox.markCommandQueued(
id: command.id,
attemptVersion: command.attemptVersion,
retryCount: attempts,
lastError: reason)
self.setOutboxState(.queued, forCommandID: command.id)
// Strict createdAt ordering: never skip ahead of a command that
// still has retries left.
self.scheduleOutboxRetry(afterAttempts: attempts)
return false
}
private func scheduleOutboxRetry(afterAttempts attempts: Int) {
let delays = self.outboxRetryDelaysMs
guard !delays.isEmpty else {
self.outboxRetryTask?.cancel()
self.outboxRetryTask = Task { [weak self] in
await Task.yield()
self?.flushOutboxIfNeeded()
}
return
}
let delayMs = delays[min(max(attempts - 1, 0), delays.count - 1)]
self.outboxRetryTask?.cancel()
self.outboxRetryTask = Task { [weak self] in
try? await Task.sleep(nanoseconds: delayMs * 1_000_000)
guard !Task.isCancelled else { return }
self?.flushOutboxIfNeeded()
}
}
private func recoverInterruptedOutboxSendsIfNeeded() async -> Bool {
guard let outbox else { return false }
// The store owns the once-per-process gate so overlapping/replacement
// view models cannot reset another active sender's claim.
return await outbox.recoverInterruptedSends()
}
func outboxAgentID(for session: SessionSnapshot) -> String? {
guard self.transport.outboxRequiresSessionRoutingContract else { return nil }
if session.key.trimmingCharacters(in: .whitespacesAndNewlines).lowercased() == "unknown" {
return nil
}
let normalized = session.deliveryAgentID?.trimmingCharacters(in: .whitespacesAndNewlines).lowercased()
return normalized?.isEmpty == false ? normalized : nil
}
private func outboxRequiresAgentID(for session: SessionSnapshot) -> Bool {
guard self.transport.outboxRequiresSessionRoutingContract else { return false }
return session.key.trimmingCharacters(in: .whitespacesAndNewlines).lowercased() != "unknown"
}
private func outboxRoutingContract(for session: SessionSnapshot) -> String? {
if !self.transport.outboxRequiresSessionRoutingContract {
return OpenClawChatOutboxCommand.legacyUnboundRoutingContract
}
let normalized = session.sessionRoutingContract?
.trimmingCharacters(in: .whitespacesAndNewlines)
return normalized?.isEmpty == false ? normalized : nil
}
/// Resolve once, before persistence. Re-resolving a presentation alias
/// after reconnect could deliver to a newly selected/default agent.
private func outboxDeliverySessionKey(
for session: SessionSnapshot,
agentID: String?) -> String?
{
let raw = session.key.trimmingCharacters(in: .whitespacesAndNewlines)
guard !raw.isEmpty else { return nil }
guard self.transport.outboxRequiresSessionRoutingContract else { return raw }
if raw.lowercased() == "unknown" { return raw }
guard let agentID else { return nil }
let normalized = raw.lowercased()
if normalized == "global" { return "global" }
if OpenClawChatSessionKey.agentID(from: raw) != nil { return raw }
// A malformed ownership prefix must fail closed, not become a nested
// key such as agent:<id>:agent::main.
guard !normalized.hasPrefix("agent:") else { return nil }
// The gateway owns structural normalization and preserves opaque
// Matrix/Signal peer IDs. Keep the request key byte-for-byte here.
return "agent:\(agentID):\(raw)"
}
private func commandMatchesTarget(
_ command: OpenClawChatOutboxCommand,
session: SessionSnapshot) -> Bool
{
guard command.sessionKey == session.key else { return false }
// Failed rows never auto-send. Keep them reachable on their original
// presentation alias after an owner change for explicit retry/delete.
if command.status == .failed { return true }
// Migrated v2 aliases have no owner and are parked as failed. Show
// them so explicit retry can adopt the currently selected agent.
guard let commandAgentID = command.agentID else { return true }
guard let currentAgentID = self.outboxAgentID(for: session) else {
// Cold offline launch has not recovered gateway ownership yet.
// Keep the durable turn visible; the route lease verifies its
// captured owner and contract before any later delivery.
return true
}
return commandAgentID == currentAgentID
}
private func setOutboxState(_ state: OpenClawChatOutboxMessageState, forCommandID commandID: String) {
guard let messageID = self.outboxMessageIDsByCommandID[commandID] else { return }
self.outboxStatesByMessageID[messageID] = state
}
private func clearOutboxState(forCommandID commandID: String) {
guard let messageID = self.outboxMessageIDsByCommandID.removeValue(forKey: commandID) else { return }
self.outboxCommandIDsByMessageID.removeValue(forKey: messageID)
self.outboxStatesByMessageID.removeValue(forKey: messageID)
self.outboxFailureVersionsByMessageID.removeValue(forKey: messageID)
}
func handleOutboxChange(_ change: OpenClawChatOutboxChange) {
// Invalidates every command snapshot that started loading before the
// store mutation, including snapshots owned by another view model.
self.outboxPresentationGeneration &+= 1
switch change {
case let .canceled(_, commandID):
// The initiating view owns its async result so canonical proof
// observed before that continuation can still preserve the row.
// Other views have no local cancellation task and apply the event.
guard !self.cancelingOutboxCommandIDs.contains(commandID) else { return }
guard let messageID = self.outboxMessageIDsByCommandID[commandID] else { return }
self.clearOutboxState(forCommandID: commandID)
self.replaceMessages(self.messages.filter { $0.id != messageID })
case let .confirmed(_, commandID):
// Canonical history owns the message row; only its outbox badge
// and command mapping disappear.
self.clearOutboxState(forCommandID: commandID)
case let .invalidated(_, scope):
let session = self.currentSessionSnapshot()
guard self.outboxBranchScope(for: session) == scope else { return }
self.reconciledOutboxBranchScopes.remove(scope)
self.restoreOutboxMessages(session: session)
}
}
private func finishOutboxCancellation(_ commandID: String) {
// Loads started while cancellation was in flight carry the previous
// generation and cannot re-present their stale command snapshot.
self.outboxPresentationGeneration &+= 1
self.cancelingOutboxCommandIDs.remove(commandID)
}
private static func outboxDisplayState(for command: OpenClawChatOutboxCommand)
-> OpenClawChatOutboxMessageState
{
switch command.status {
case .queued:
.queued
case .sending:
.sending
case .awaitingConfirmation:
.confirming
case .failed where command.lastError == OpenClawChatSQLiteTranscriptCache.outboxChangedTargetError:
.failed(reason: "Gateway session routing changed; review and retry this message.")
case .failed:
.failed(reason: OpenClawChatSQLiteTranscriptCache.outboxDisplayError(command.lastError))
}
}
/// Matches the optimistic-send convention (`"<runId>:user"`), which is
/// also the key the gateway persists on the durable user row.
static func outboxUserIdempotencyKey(_ commandID: String) -> String {
"\(commandID):user"
}
}
|