forked from loopx-project/loopx
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsettlement.ts
More file actions
904 lines (848 loc) · 26.6 KB
/
Copy pathsettlement.ts
File metadata and controls
904 lines (848 loc) · 26.6 KB
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
import {
commitStepPayload,
isCommittedPayload,
requireMatchingEffectId,
seedCommittedSteps,
settlementFailed,
settlementIdentityFromPlan,
settlementNextAction,
settlementPure,
settlementResultPayload,
type JsonObject,
type SettlementFailureResult,
type SettlementIdentity,
type SettlementResult,
type SettlementStepKind,
} from "../effect_program.ts";
import {
optionalNonEmptyString,
requireBoolean,
requireJsonObject,
requireNonEmptyString,
requireStringArray,
requireStringLiteral,
} from "../runtime_decode.ts";
export const TURN_SETTLEMENT_TRANSACTION_SCHEMA_VERSION =
"loopx_turn_settlement_transaction_v0";
export const TURN_SETTLEMENT_REDUCTION_SCHEMA_VERSION =
"loopx_turn_settlement_reduction_v0";
export const TURN_SETTLEMENT_OUTCOME_SCHEMA_VERSION =
"loopx_turn_settlement_outcome_v0";
const BASE_SETTLEMENT_STEPS = [
"validation",
"durable_writeback",
"quota_spend",
] as const satisfies readonly SettlementStepKind[];
const PROVIDER_STEP_KINDS = [
"durable_writeback",
"quota_spend",
"terminal_closeout",
] as const;
type ProviderStepKind = (typeof PROVIDER_STEP_KINDS)[number];
const PROVIDER_RESOLUTION_KINDS = ["committed", "absent", "unknown"] as const;
type ProviderResolutionKind = (typeof PROVIDER_RESOLUTION_KINDS)[number];
/** Compatibility exports; definitions are generated from the shared contract. */
import { TURN_RESULT_KINDS, type TurnResultKind } from "./turn_contract_generated.ts";
export { TURN_RESULT_KINDS, type TurnResultKind } from "./turn_contract_generated.ts";
const FAILED_TURN_RESULT_KINDS = [
"host_failure",
"validation_failed",
"writeback_failed",
"quota_spend_failed",
"terminal_closeout_failed",
] as const satisfies readonly TurnResultKind[];
interface PreparedEffectAttempt {
status: "prepared";
effect_ref: string;
}
interface ProviderObservation {
kind: ProviderResolutionKind;
payload: JsonObject | null;
reason: string | null;
}
interface FailedProviderAttempt {
step_kind: ProviderStepKind;
payload: JsonObject;
}
interface ProviderExecutionEffect {
step_kind: ProviderStepKind;
action: "prepare_and_execute";
effect_ref: string;
completed_phases: readonly string[];
}
interface ProviderResolutionEffect {
step_kind: ProviderStepKind;
action: "resolve_prepared";
effect_ref: string;
completed_phases: readonly string[];
resolution_policy: {
committed: "checkpoint";
absent: "execute";
unknown: "fail_closed";
};
}
type ProviderEffect = ProviderExecutionEffect | ProviderResolutionEffect;
interface TurnSettlementRequest {
schema_version: typeof TURN_SETTLEMENT_TRANSACTION_SCHEMA_VERSION;
transaction_plan: JsonObject;
transaction_phases: readonly string[];
completed_phases: readonly string[];
committed_effect_id: string | null;
writeback_payload: JsonObject | null;
quota_spend_payload: JsonObject | null;
terminal_closeout_required: boolean;
terminal_closeout_payload: JsonObject | null;
failed_provider_attempt: FailedProviderAttempt | null;
effect_attempts: Partial<Record<ProviderStepKind, PreparedEffectAttempt>>;
provider_observations: Partial<Record<ProviderStepKind, ProviderObservation>>;
turn_result_kind: TurnResultKind | null;
}
export interface TurnSettlementState {
completed_phases: readonly string[];
writeback: JsonObject | null;
quota_spend: JsonObject | null;
}
interface TurnSettlementExecution {
schema_version: typeof TURN_SETTLEMENT_REDUCTION_SCHEMA_VERSION;
decision: "execute";
provider_effects: readonly ProviderEffect[];
result: null;
settlement_result: null;
}
interface TurnSettlementOutcome {
schema_version: typeof TURN_SETTLEMENT_REDUCTION_SCHEMA_VERSION;
decision: "complete" | "failed";
provider_effects: readonly [];
result: SettlementResult<TurnSettlementState>;
settlement_result: JsonObject;
}
export type TurnSettlementReduction =
| TurnSettlementExecution
| TurnSettlementOutcome;
function optionalObject(value: unknown, label: string): JsonObject | null {
if (value === null || value === undefined) return null;
return requireJsonObject(value, label);
}
function decodeFailedProviderAttempt(
value: unknown,
): FailedProviderAttempt | null {
if (value === null || value === undefined) return null;
const attempt = requireJsonObject(value, "failed_provider_attempt");
return {
step_kind: requireStringLiteral(
attempt.step_kind,
PROVIDER_STEP_KINDS,
"failed_provider_attempt.step_kind",
),
payload: requireJsonObject(
attempt.payload,
"failed_provider_attempt.payload",
),
};
}
function decodeProviderRecord<Value>(
value: unknown,
label: string,
decode: (value: unknown, label: string) => Value,
): Partial<Record<ProviderStepKind, Value>> {
if (value === null || value === undefined) return {};
const record = requireJsonObject(value, label);
const decoded: Partial<Record<ProviderStepKind, Value>> = {};
for (const [rawStep, rawValue] of Object.entries(record)) {
const step = requireStringLiteral(
rawStep,
PROVIDER_STEP_KINDS,
`${label} step`,
);
decoded[step] = decode(rawValue, `${label}.${step}`);
}
return decoded;
}
function decodePreparedAttempt(
value: unknown,
label: string,
): PreparedEffectAttempt {
const attempt = requireJsonObject(value, label);
return {
status: requireStringLiteral(
attempt.status,
["prepared"] as const,
`${label}.status`,
),
effect_ref: requireNonEmptyString(attempt.effect_ref, `${label}.effect_ref`),
};
}
function decodeProviderObservation(
value: unknown,
label: string,
): ProviderObservation {
const observation = requireJsonObject(value, label);
return {
kind: requireStringLiteral(
observation.kind,
PROVIDER_RESOLUTION_KINDS,
`${label}.kind`,
),
payload: optionalObject(observation.payload, `${label}.payload`),
reason: optionalNonEmptyString(observation.reason, `${label}.reason`),
};
}
function decodeRequest(value: unknown): TurnSettlementRequest {
const request = requireJsonObject(value, "Turn settlement request");
const schemaVersion = requireStringLiteral(
request.schema_version,
[TURN_SETTLEMENT_TRANSACTION_SCHEMA_VERSION] as const,
"schema_version",
);
return {
schema_version: schemaVersion,
transaction_plan: requireJsonObject(
request.transaction_plan,
"transaction_plan",
),
transaction_phases: requireStringArray(
request.transaction_phases,
"transaction_phases",
),
completed_phases: requireStringArray(
request.completed_phases,
"completed_phases",
),
committed_effect_id: optionalNonEmptyString(
request.committed_effect_id,
"committed_effect_id",
),
writeback_payload: optionalObject(
request.writeback_payload,
"writeback_payload",
),
quota_spend_payload: optionalObject(
request.quota_spend_payload,
"quota_spend_payload",
),
terminal_closeout_required: requireBoolean(
request.terminal_closeout_required,
"terminal_closeout_required",
),
terminal_closeout_payload: optionalObject(
request.terminal_closeout_payload,
"terminal_closeout_payload",
),
failed_provider_attempt: decodeFailedProviderAttempt(
request.failed_provider_attempt,
),
effect_attempts: decodeProviderRecord(
request.effect_attempts,
"effect_attempts",
decodePreparedAttempt,
),
provider_observations: decodeProviderRecord(
request.provider_observations,
"provider_observations",
decodeProviderObservation,
),
turn_result_kind: request.turn_result_kind === null ||
request.turn_result_kind === undefined
? null
: requireStringLiteral(
request.turn_result_kind,
TURN_RESULT_KINDS,
"turn_result_kind",
),
};
}
function validateTurnOutcomeKind(
request: TurnSettlementRequest,
): void {
const kind = request.turn_result_kind;
if (kind === null) return;
if (kind === "iteration_failed") {
throw new Error(
"Turn settlement cannot run for iteration stop result_kind iteration_failed",
);
}
if (FAILED_TURN_RESULT_KINDS.includes(kind as (typeof FAILED_TURN_RESULT_KINDS)[number])) {
throw new Error(
`Turn settlement cannot complete with failed result_kind ${kind}`,
);
}
}
function completionOutcomeError(
identity: SettlementIdentity,
payload: JsonObject,
): string | null {
const completion = payload.completion;
if (completion === null || completion === undefined) {
return "completion is missing its durable Todo outcome";
}
if (typeof completion !== "object" || Array.isArray(completion)) {
return "completion has an invalid durable Todo outcome";
}
const outcome = completion as JsonObject;
if (outcome.todo_id !== identity.todo_id) {
return "completion does not match the selected Todo";
}
if (
outcome.continuation !== "successor" &&
outcome.continuation !== "active_goal" &&
outcome.continuation !== "no_followup"
) {
return "completion has an invalid continuation outcome";
}
if (
outcome.continuation === "successor" &&
(!Array.isArray(outcome.successor_todo_ids) ||
outcome.successor_todo_ids.length === 0 ||
!outcome.successor_todo_ids.every(
(todoId) => typeof todoId === "string" && todoId.length > 0,
))
) {
return "successor completion requires successor Todo ids";
}
return null;
}
function terminalCompletionError(
identity: SettlementIdentity,
payload: JsonObject,
): string | null {
const error = completionOutcomeError(identity, payload);
if (error !== null) return error;
const completion = payload.completion as JsonObject;
if (completion.continuation !== "no_followup") {
return "terminal closeout completion must declare no_followup";
}
return null;
}
function nonTerminalCompletionError(
identity: SettlementIdentity,
payload: JsonObject,
): string | null {
const error = completionOutcomeError(identity, payload);
if (error !== null) return error;
const completion = payload.completion as JsonObject;
if (completion.continuation === "no_followup") {
return "non-terminal completion cannot declare no_followup";
}
return null;
}
function reductionWithTurnOutcome(
request: TurnSettlementRequest,
state: TurnSettlementState,
receipts: SettlementResult<unknown>["receipts"],
terminalPayload: JsonObject | null,
identity: SettlementIdentity,
): TurnSettlementOutcome {
validateTurnOutcomeKind(request);
const result = settlementPure(state, receipts);
const projection = settlementResultPayload(result);
if (request.turn_result_kind !== null) {
const outcome: JsonObject = {
schema_version: TURN_SETTLEMENT_OUTCOME_SCHEMA_VERSION,
result_kind: request.turn_result_kind,
completed_phases: [...state.completed_phases],
failed_phase: null,
};
if (request.turn_result_kind === "validated_completion") {
const completion = terminalPayload?.completion ?? state.writeback?.completion;
if (completion !== undefined) outcome.completion = completion;
}
projection.turn_outcome = outcome;
}
return {
schema_version: TURN_SETTLEMENT_REDUCTION_SCHEMA_VERSION,
decision: "complete",
provider_effects: [],
result,
settlement_result: projection,
};
}
function resultKindForFailedStep(stepKind: SettlementStepKind): TurnResultKind {
switch (stepKind) {
case "validation":
return "validation_failed";
case "durable_writeback":
return "writeback_failed";
case "quota_spend":
return "quota_spend_failed";
case "terminal_closeout":
return "terminal_closeout_failed";
default:
throw new Error(`Turn settlement cannot project failed step ${stepKind}`);
}
}
function reductionWithTurnFailure(
request: TurnSettlementRequest,
result: SettlementResult<TurnSettlementState>,
): TurnSettlementOutcome {
if (result.failure === null || request.turn_result_kind === null) {
return reduction(result);
}
const projection = settlementResultPayload(result);
projection.turn_outcome = {
schema_version: TURN_SETTLEMENT_OUTCOME_SCHEMA_VERSION,
result_kind: resultKindForFailedStep(result.failure.step_kind),
completed_phases: [...request.completed_phases],
failed_phase: result.failure.step_kind,
};
return {
schema_version: TURN_SETTLEMENT_REDUCTION_SCHEMA_VERSION,
decision: "failed",
provider_effects: [],
result,
settlement_result: projection,
};
}
function withTurnOutcome(
request: TurnSettlementRequest,
reduced: TurnSettlementReduction,
): TurnSettlementReduction {
if (reduced.decision !== "failed" || reduced.result.failure === null) {
return reduced;
}
return reductionWithTurnFailure(request, reduced.result);
}
function reduction(
result: SettlementResult<TurnSettlementState>,
): TurnSettlementOutcome {
return {
schema_version: TURN_SETTLEMENT_REDUCTION_SCHEMA_VERSION,
decision: result.failure === null ? "complete" : "failed",
provider_effects: [],
result,
settlement_result: settlementResultPayload(result),
};
}
function execution(
providerEffects: readonly ProviderEffect[],
): TurnSettlementExecution {
return {
schema_version: TURN_SETTLEMENT_REDUCTION_SCHEMA_VERSION,
decision: "execute",
provider_effects: providerEffects,
result: null,
settlement_result: null,
};
}
function failedState(
failure: SettlementFailureResult,
): TurnSettlementOutcome {
return reduction(failure);
}
function providerFailure(
identity: SettlementIdentity,
request: TurnSettlementRequest,
stepKind: ProviderStepKind,
receipts: SettlementResult<unknown>["receipts"],
): TurnSettlementOutcome {
const attempt = request.failed_provider_attempt;
if (!attempt || attempt.step_kind !== stepKind) {
return reduction(
settlementFailed({
kind: "receipt_missing",
step_kind: stepKind,
reason: `Turn settlement is missing its ${stepKind} provider outcome`,
receipts,
}),
);
}
const committed = commitStepPayload({
identity,
step_kind: stepKind,
transaction_phases:
stepKind === "terminal_closeout"
? ["terminal_closeout"]
: request.transaction_phases,
payload: attempt.payload,
});
if (committed.result.failure === null) {
throw new Error(
`failed_provider_attempt for ${stepKind} unexpectedly committed`,
);
}
return reduction({
value: null,
receipts: [...receipts, ...committed.result.receipts],
failure: committed.result.failure,
});
}
function pendingProviderEffects(
request: TurnSettlementRequest,
identity: SettlementIdentity,
firstStep: ProviderStepKind,
): readonly ProviderEffect[] {
const completed = new Set(request.completed_phases);
const effects: ProviderEffect[] = [];
for (const step of BASE_SETTLEMENT_STEPS) {
if (step === "validation" || completed.has(step)) continue;
const phaseIndex = request.transaction_phases.indexOf(step);
if (phaseIndex < 0) {
throw new Error(`transaction phases do not contain ${step}`);
}
effects.push({
step_kind: step,
action: "prepare_and_execute",
effect_ref: `${identity.effect_id}#${step}`,
completed_phases: request.transaction_phases.slice(0, phaseIndex + 1),
});
}
if (effects[0]?.step_kind !== firstStep) {
throw new Error(`Turn settlement next provider is not ${firstStep}`);
}
if (request.terminal_closeout_required) {
effects.push({
step_kind: "terminal_closeout",
action: "prepare_and_execute",
effect_ref: `${identity.effect_id}#terminal_closeout`,
completed_phases: [...request.completed_phases],
});
}
return effects.slice(0, 1);
}
function terminalCloseoutRequestFailure(
request: TurnSettlementRequest,
): SettlementResult<TurnSettlementState> | null {
if (
request.terminal_closeout_required &&
request.turn_result_kind !== null &&
request.turn_result_kind !== "validated_completion"
) {
return settlementFailed<TurnSettlementState>({
kind: "terminal_closeout_rejected",
step_kind: "terminal_closeout",
reason: "terminal closeout requires a validated completion result",
receipts: [],
});
}
return null;
}
function reduceBaseProviderAction(
request: TurnSettlementRequest,
identity: SettlementIdentity,
stepKind: ProviderStepKind,
receipts: SettlementResult<unknown>["receipts"],
): TurnSettlementReduction {
const effects = pendingProviderEffects(request, identity, stepKind);
return request.failed_provider_attempt === null
? providerExecution(request, identity, stepKind, effects, receipts)
: providerFailure(identity, request, stepKind, receipts);
}
type TerminalCloseoutReduction =
| { outcome: TurnSettlementReduction; receipts?: never }
| { outcome?: never; receipts: SettlementResult<unknown>["receipts"] };
function reduceTerminalCloseout(
request: TurnSettlementRequest,
identity: SettlementIdentity,
receipts: SettlementResult<unknown>["receipts"],
): TerminalCloseoutReduction {
if (!request.terminal_closeout_required) {
if (request.terminal_closeout_payload !== null) {
return {
outcome: reduction(
settlementFailed({
kind: "terminal_closeout_rejected",
step_kind: "terminal_closeout",
reason: "Turn settlement contains an unrequested terminal closeout",
receipts,
}),
),
};
}
return { receipts };
}
if (request.terminal_closeout_payload === null) {
const effects: readonly ProviderEffect[] = [
{
step_kind: "terminal_closeout",
action: "prepare_and_execute",
effect_ref: `${identity.effect_id}#terminal_closeout`,
completed_phases: [...request.completed_phases],
},
];
return {
outcome: request.failed_provider_attempt === null
? providerExecution(
request,
identity,
"terminal_closeout",
effects,
receipts,
)
: providerFailure(identity, request, "terminal_closeout", receipts),
};
}
const terminal = seedCommittedSteps({
identity,
ordered_steps: ["terminal_closeout"],
committed_payloads: {
terminal_closeout: request.terminal_closeout_payload,
},
completed_phases: ["terminal_closeout"],
transaction_phases: ["terminal_closeout"],
require_validation: false,
source_ref_prefix: "turn_journal",
});
if (terminal.failure !== null) return { outcome: failedState(terminal) };
const completionError = request.turn_result_kind === null
? null
: terminalCompletionError(identity, request.terminal_closeout_payload);
if (completionError !== null) {
return {
outcome: reduction(
settlementFailed({
kind: "receipt_missing",
step_kind: "terminal_closeout",
reason: completionError,
receipts,
}),
),
};
}
return { receipts: [...receipts, ...terminal.receipts] };
}
function providerExecution(
request: TurnSettlementRequest,
identity: SettlementIdentity,
firstStep: ProviderStepKind,
effects: readonly ProviderEffect[],
receipts: SettlementResult<unknown>["receipts"],
): TurnSettlementReduction {
const attempts = Object.entries(request.effect_attempts) as Array<
[ProviderStepKind, PreparedEffectAttempt]
>;
const observations = Object.entries(request.provider_observations) as Array<
[ProviderStepKind, ProviderObservation]
>;
if (attempts.length === 0) {
if (observations.length > 0) {
return reduction(
settlementFailed({
kind: "receipt_missing",
step_kind: observations[0][0],
reason: "Turn settlement has a provider observation without a prepared effect",
receipts,
}),
);
}
return execution(effects);
}
const unexpected = attempts.find(([step]) => step !== firstStep);
if (attempts.length !== 1 || unexpected) {
const step = unexpected?.[0] ?? attempts[1]?.[0] ?? attempts[0][0];
return reduction(
settlementFailed({
kind: "receipt_missing",
step_kind: step,
reason: "Prepared settlement effects do not match the next ordered provider",
receipts,
}),
);
}
const attempt = attempts[0][1];
const expectedRef = `${identity.effect_id}#${firstStep}`;
if (attempt.effect_ref !== expectedRef) {
return reduction(
settlementFailed({
kind: "identity_mismatch",
step_kind: firstStep,
reason:
`Prepared settlement effect does not match the current operation: ` +
`journal effect is ${attempt.effect_ref} but plan effect is ${expectedRef}`,
receipts,
}),
);
}
const strayObservation = observations.find(([step]) => step !== firstStep);
if (strayObservation) {
return reduction(
settlementFailed({
kind: "receipt_missing",
step_kind: strayObservation[0],
reason: "Provider observation does not match the prepared settlement effect",
receipts,
}),
);
}
const observation = request.provider_observations[firstStep];
if (observation?.kind === "unknown") {
return reduction(
settlementFailed({
kind: "effect_outcome_unknown",
step_kind: firstStep,
reason:
observation.reason ??
"Provider could not resolve the prepared settlement effect",
receipts,
}),
);
}
if (
observation?.kind === "committed" &&
!isCommittedPayload(observation.payload)
) {
return reduction(
settlementFailed({
kind: "receipt_missing",
step_kind: firstStep,
reason:
"Provider reported a committed settlement effect without a durable committed payload",
receipts,
}),
);
}
if (observation !== undefined) {
return reduction(
settlementFailed({
kind: "effect_outcome_unknown",
step_kind: firstStep,
reason:
"Prepared provider observation was not durably checkpointed by the adapter",
receipts,
}),
);
}
const effect = effects.find((candidate) => candidate.step_kind === firstStep);
if (!effect) {
throw new Error(`Turn settlement has no provider effect for ${firstStep}`);
}
return execution([
{
step_kind: firstStep,
action: "resolve_prepared",
effect_ref: expectedRef,
completed_phases: effect.completed_phases,
resolution_policy: {
committed: "checkpoint",
absent: "execute",
unknown: "fail_closed",
},
},
...effects.filter((candidate) => candidate.step_kind !== firstStep),
]);
}
/**
* Reduce one complete Turn settlement snapshot.
*
* The first reduction validates identity, replay, and the committed journal
* prefix before authorizing still-Python provider effects. The second reduces
* their checkpointed outcomes into the canonical receipt chain and result.
* A replay that needs no provider effect completes in one reduction.
*/
function reduceTurnSettlementRequest(
request: TurnSettlementRequest,
): TurnSettlementReduction {
const identityResult = settlementIdentityFromPlan(request.transaction_plan);
if (identityResult.failure !== null) return failedState(identityResult);
const identity = identityResult.value;
const matching = requireMatchingEffectId(
request.committed_effect_id,
identity.effect_id,
);
if (matching.failure !== null) return failedState(matching);
const terminalRequestFailure = terminalCloseoutRequestFailure(request);
if (terminalRequestFailure !== null) return reduction(terminalRequestFailure);
const base = settlementNextAction({
identity,
ordered_steps: BASE_SETTLEMENT_STEPS,
committed_payloads: {
validation: {},
durable_writeback: request.writeback_payload,
quota_spend: request.quota_spend_payload,
},
completed_phases: request.completed_phases,
transaction_phases: request.transaction_phases,
require_validation: true,
source_ref_prefix: "turn_journal",
});
if (base.decision === "failed") return failedState(base.result);
if (base.decision === "execute") {
if (base.step_kind === "validation" || base.step_kind === "terminal_closeout") {
throw new Error(`unsupported base settlement step ${base.step_kind}`);
}
if (
base.step_kind === "quota_spend" &&
request.turn_result_kind === "validated_completion" &&
!request.terminal_closeout_required &&
request.writeback_payload !== null
) {
const completionError = nonTerminalCompletionError(
identity,
request.writeback_payload,
);
if (completionError !== null) {
return reduction(
settlementFailed({
kind: "receipt_missing",
step_kind: "durable_writeback",
reason: completionError,
receipts: base.result.receipts,
}),
);
}
}
return reduceBaseProviderAction(
request,
identity,
base.step_kind,
base.result.receipts,
);
}
let receipts: SettlementResult<unknown>["receipts"] = [...base.result.receipts];
if (
request.turn_result_kind === "validated_completion" &&
!request.terminal_closeout_required &&
request.writeback_payload !== null
) {
const completionError = nonTerminalCompletionError(
identity,
request.writeback_payload,
);
if (completionError !== null) {
return reduction(
settlementFailed({
kind: "receipt_missing",
step_kind: "durable_writeback",
reason: completionError,
receipts,
}),
);
}
}
const terminal = reduceTerminalCloseout(request, identity, receipts);
if (terminal.outcome !== undefined) return terminal.outcome;
receipts = terminal.receipts;
const danglingAttempt = Object.keys(request.effect_attempts)[0] as
| ProviderStepKind
| undefined;
if (danglingAttempt) {
return reduction(
settlementFailed({
kind: "receipt_missing",
step_kind: danglingAttempt,
reason: "Turn settlement has a prepared effect after its provider phase",
receipts,
}),
);
}
if (request.failed_provider_attempt !== null) {
throw new Error(
"failed_provider_attempt remains after all required settlement effects committed",
);
}
return reductionWithTurnOutcome(
request,
{
completed_phases: [...request.completed_phases],
writeback: request.writeback_payload,
quota_spend: request.quota_spend_payload,
},
receipts,
request.terminal_closeout_payload,
identity,
);
}
export function reduceTurnSettlementTransaction(
value: unknown,
): TurnSettlementReduction {
const request = decodeRequest(value);
return withTurnOutcome(request, reduceTurnSettlementRequest(request));
}