oracledb-protocol 0.2.2

Sans-I/O Oracle TNS/TTC protocol core for the oracledb crate.
Documentation
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
#![forbid(unsafe_code)]

use super::*;

/// Body of the transaction-switch message (reference impl/thin/messages/
/// tpc_switch.pyx `_write_message`), shared by the direct function call and the
/// piggyback forms. `xid` is the (format_id, global_txn_id) of a sessionless
/// transaction being started; `None` for a suspend/detach which carries no XID.
pub(crate) fn write_tpc_txn_switch_body(
    writer: &mut TtcWriter,
    operation: u32,
    flags: u32,
    timeout: u32,
    xid: Option<&[u8]>,
) {
    writer.write_ub4(operation);
    writer.write_u8(0); // pointer (transaction context)
    writer.write_ub4(0); // transaction context length
    if let Some(global_txn_id) = xid {
        // sessionless transactions send only a global transaction id; the
        // branch qualifier is empty and the combined value is right-padded
        // with zero bytes to 128 bytes (tpc_switch.pyx:80-81).
        let mut xid_bytes = global_txn_id.to_vec();
        xid_bytes.resize(128, 0);
        writer.write_ub4(SESSIONLESS_FORMAT_ID);
        writer.write_ub4(u32::try_from(global_txn_id.len()).unwrap_or(0)); // global txn id len
        writer.write_ub4(0); // branch qualifier length
        writer.write_u8(1); // pointer (XID)
        writer.write_ub4(u32::try_from(xid_bytes.len()).unwrap_or(0));
        writer.write_ub4(flags);
        writer.write_ub4(timeout);
        writer.write_u8(1); // pointer (application value)
        writer.write_u8(1); // pointer (return context)
        writer.write_u8(1); // pointer (return context length)
        writer.write_u8(0); // pointer (internal name)
        writer.write_ub4(0); // length of internal name
        writer.write_u8(0); // pointer (external name)
        writer.write_ub4(0); // length of external name
        writer.write_raw(&xid_bytes);
        writer.write_ub4(0); // application value
    } else {
        writer.write_ub4(0); // format id
        writer.write_ub4(0); // global transaction id length
        writer.write_ub4(0); // branch qualifier length
        writer.write_u8(0); // pointer (XID)
        writer.write_ub4(0); // XID length
        writer.write_ub4(flags);
        writer.write_ub4(timeout);
        writer.write_u8(1); // pointer (application value)
        writer.write_u8(1); // pointer (return context)
        writer.write_u8(1); // pointer (return context length)
        writer.write_u8(0); // pointer (internal name)
        writer.write_ub4(0); // length of internal name
        writer.write_u8(0); // pointer (external name)
        writer.write_ub4(0); // length of external name
        writer.write_ub4(0); // application value
    }
}

/// Direct (non-deferred) transaction-switch function call used to begin/resume
/// (`TNS_TPC_TXN_START` + new/resume flag, with `xid`) or suspend
/// (`TNS_TPC_TXN_DETACH`, no `xid`) a sessionless transaction. Reference
/// impl/thin/connection.pyx `begin/resume/suspend_sessionless_transaction`.
pub fn build_tpc_txn_switch_payload_with_seq(
    seq_num: u8,
    token_num: u64,
    operation: u32,
    flags: u32,
    timeout: u32,
    xid: Option<&[u8]>,
) -> Vec<u8> {
    let mut writer = TtcWriter::new();
    writer.write_function_code_with_seq(TNS_FUNC_TPC_TXN_SWITCH, seq_num);
    writer.write_ub8(token_num);
    write_tpc_txn_switch_body(&mut writer, operation, flags, timeout, xid);
    writer.into_bytes()
}

/// Sessionless transaction-switch piggyback, prepended to the next execute
/// message's payload (reference messages/base.pyx `_write_sessionless_piggyback`
/// — the same message body written with a `TNS_MSG_TYPE_PIGGYBACK` header). Used
/// for a deferred begin/resume (`defer_round_trip=True`) and for the
/// `suspend_on_success` post-detach. `operation` already encodes whether a
/// post-detach is folded in (`TNS_TPC_TXN_START | TNS_TPC_TXN_POST_DETACH`).
pub fn build_sessionless_piggyback(
    seq_num: u8,
    token_num: u64,
    operation: u32,
    flags: u32,
    timeout: u32,
    xid: Option<&[u8]>,
) -> Vec<u8> {
    let mut writer = TtcWriter::new();
    writer.write_u8(TNS_MSG_TYPE_PIGGYBACK);
    writer.write_u8(TNS_FUNC_TPC_TXN_SWITCH);
    writer.write_u8(seq_num);
    writer.write_ub8(token_num);
    write_tpc_txn_switch_body(&mut writer, operation, flags, timeout, xid);
    writer.into_bytes()
}

/// Decode the sessionless state bits packed in the transaction-id key/value
/// binary payload (reference `_update_sessionless_txn_state`). The last two
/// bytes are the state mask and the sync version; the leading bytes are the
/// transaction id itself.
pub fn decode_sessionless_txn_state(binary: &[u8]) -> Result<Option<SessionlessTxnState>> {
    if binary.len() < 2 {
        return Err(ProtocolError::TtcDecode("short sessionless txn state"));
    }
    let state = binary[binary.len() - 2];
    let sync_version = binary[binary.len() - 1];
    if sync_version != 1 {
        return Err(ProtocolError::TtcDecode("unknown transaction sync version"));
    }
    if state & TNS_TPC_TXNID_SYNC_UNSET != 0 {
        Ok(Some(SessionlessTxnState::Unset))
    } else if state & TNS_TPC_TXNID_SYNC_SET != 0 {
        Ok(Some(SessionlessTxnState::Set {
            started_on_server: state & TNS_TPC_TXNID_SYNC_SERVER != 0,
        }))
    } else {
        Ok(None)
    }
}

/// Parse a transaction-switch response (reference tpc_switch.pyx
/// `_process_return_parameters` plus base.pyx message loop). Returns any
/// sessionless state update carried by a transaction-id key/value pair; server
/// errors (e.g. ORA-25351 / ORA-26217) are surfaced as `ProtocolError`.
pub fn parse_tpc_txn_switch_response(
    payload: &[u8],
    capabilities: ClientCapabilities,
) -> Result<Option<SessionlessTxnState>> {
    let mut reader = TtcReader::new(payload);
    let mut state = None;
    while reader.remaining() > 0 {
        let message_type = reader.read_u8()?;
        match message_type {
            0 => {}
            TNS_MSG_TYPE_STATUS => {
                let _call_status = reader.read_ub4()?;
                let _seq = reader.read_ub2()?;
            }
            TNS_MSG_TYPE_PARAMETER => {
                // tpc_switch.pyx `_process_return_parameters`: application value
                // (ub4) then the return transaction context (ub2 length + bytes).
                let _application_value = reader.read_ub4()?;
                let context_len = reader.read_ub2()?;
                if context_len > 0 {
                    reader.skip(usize::from(context_len))?;
                }
            }
            TNS_MSG_TYPE_SERVER_SIDE_PIGGYBACK => {
                if let Some(update) = skip_server_side_piggyback(&mut reader)? {
                    state = Some(update);
                }
            }
            TNS_MSG_TYPE_END_OF_RESPONSE => break,
            TNS_MSG_TYPE_ERROR => {
                let info = parse_server_error_info(&mut reader, capabilities.ttc_field_version)?;
                if info.number != 0 {
                    return Err(ProtocolError::ServerErrorInfo(Box::new(
                        info.into_details(),
                    )));
                }
            }
            _ => break,
        }
    }
    Ok(state)
}

/// Begin-pipeline piggyback (messages/base.pyx `_write_begin_pipeline_piggyback`
/// and `_write_piggyback_code`): prepended to the first pipelined message's
/// payload. The packet carrying it must set [`TNS_DATA_FLAGS_BEGIN_PIPELINE`].
///
/// `token_num` is the token of the message the piggyback rides on (1 for the
/// first pipeline operation); `pipeline_mode` is one of
/// [`TNS_PIPELINE_MODE_CONTINUE_ON_ERROR`] / [`TNS_PIPELINE_MODE_ABORT_ON_ERROR`].
pub fn build_begin_pipeline_piggyback(seq_num: u8, token_num: u64, pipeline_mode: u8) -> Vec<u8> {
    let mut writer = TtcWriter::new();
    writer.write_u8(TNS_MSG_TYPE_PIGGYBACK);
    writer.write_u8(TNS_FUNC_PIPELINE_BEGIN);
    writer.write_u8(seq_num);
    writer.write_ub8(token_num);
    writer.write_ub2(0); // error set ID
    writer.write_u8(0); // error set mode
    writer.write_u8(pipeline_mode);
    writer.into_bytes()
}

/// End-pipeline message (messages/end_pipeline.pyx): function 200 plus an
/// unused ub4 identifier. Sent after every pipelined operation message; its
/// packet carries no END_OF_REQUEST flag and its response is the final
/// (N+1th) boundary-delimited response of the pipeline.
pub fn build_end_pipeline_payload_with_seq(seq_num: u8) -> Vec<u8> {
    let mut writer = TtcWriter::new();
    writer.write_function_code_with_seq(TNS_FUNC_PIPELINE_END, seq_num);
    writer.write_ub8(0); // token (the end-pipeline message itself has none)
    writer.write_ub4(0); // error set ID (unused)
    writer.into_bytes()
}

/// A two-phase-commit transaction id (reference `Xid` namedtuple). The
/// `global_transaction_id` and `branch_qualifier` are the raw (already
/// UTF-8 encoded) byte values; the shim coerces `str` members before calling.
#[derive(Clone, Debug)]
pub struct TpcXid<'a> {
    pub format_id: u32,
    pub global_transaction_id: &'a [u8],
    pub branch_qualifier: &'a [u8],
}

/// Writes the XID descriptor + the 128-byte zero-padded XID block, shared by
/// the full-XA switch (func 103) and change-state (func 104) messages. The
/// descriptor (`format_id`, gtid length, bqual length, pointer, block length)
/// is written at the caller-specified position; the 128-byte block itself is
/// written by [`write_xid_block_bytes`] later in the message body, after the
/// context bytes (reference tpc_switch.pyx / tpc_change_state.pyx).
fn write_xid_descriptor(writer: &mut TtcWriter, xid: Option<&TpcXid<'_>>) {
    match xid {
        Some(xid) => {
            writer.write_ub4(xid.format_id);
            writer.write_ub4(u32::try_from(xid.global_transaction_id.len()).unwrap_or(0));
            writer.write_ub4(u32::try_from(xid.branch_qualifier.len()).unwrap_or(0));
            writer.write_u8(1); // pointer (XID)
            writer.write_ub4(128); // length of the XID block
        }
        None => {
            writer.write_ub4(0); // format id
            writer.write_ub4(0); // global transaction id length
            writer.write_ub4(0); // branch qualifier length
            writer.write_u8(0); // pointer (XID)
            writer.write_ub4(0); // XID length
        }
    }
}

/// The 128-byte XID block: `global_transaction_id + branch_qualifier`,
/// right-zero-padded to exactly 128 bytes (reference tpc_switch.pyx:80-81).
fn write_xid_block_bytes(writer: &mut TtcWriter, xid: &TpcXid<'_>) {
    let mut xid_bytes = Vec::with_capacity(128);
    xid_bytes.extend_from_slice(xid.global_transaction_id);
    xid_bytes.extend_from_slice(xid.branch_qualifier);
    xid_bytes.resize(128, 0);
    writer.write_raw(&xid_bytes);
}

/// Full-XA transaction-switch payload (func 103), used by `tpc_begin`
/// (`operation = TNS_TPC_TXN_START`) and `tpc_end` (`operation =
/// TNS_TPC_TXN_DETACH`). Unlike [`build_tpc_txn_switch_payload_with_seq`] (the
/// sessionless special case) this carries a real `format_id`, a non-empty
/// branch qualifier, and the captured transaction `context` to echo back.
/// Reference messages/tpc_switch.pyx `_write_message`.
pub fn build_tpc_switch_payload_with_seq(
    seq_num: u8,
    operation: u32,
    flags: u32,
    timeout: u32,
    xid: Option<&TpcXid<'_>>,
    context: Option<&[u8]>,
) -> Vec<u8> {
    let mut writer = TtcWriter::new();
    writer.write_function_code_with_seq(TNS_FUNC_TPC_TXN_SWITCH, seq_num);
    writer.write_ub8(0); // token
    writer.write_ub4(operation);
    match context {
        Some(context) => {
            writer.write_u8(1); // pointer (transaction context)
            writer.write_ub4(u32::try_from(context.len()).unwrap_or(0));
        }
        None => {
            writer.write_u8(0); // pointer (transaction context)
            writer.write_ub4(0); // transaction context length
        }
    }
    write_xid_descriptor(&mut writer, xid);
    writer.write_ub4(flags);
    writer.write_ub4(timeout);
    writer.write_u8(1); // pointer (application value)
    writer.write_u8(1); // pointer (return context)
    writer.write_u8(1); // pointer (return context length)
    writer.write_u8(0); // pointer (internal name)
    writer.write_ub4(0); // length of internal name
    writer.write_u8(0); // pointer (external name)
    writer.write_ub4(0); // length of external name
    if let Some(context) = context {
        writer.write_raw(context);
    }
    if let Some(xid) = xid {
        write_xid_block_bytes(&mut writer, xid);
    }
    writer.write_ub4(0); // application value
    writer.into_bytes()
}

/// TPC transaction change-state payload (func 104), used by `tpc_prepare`
/// (`operation = TNS_TPC_TXN_PREPARE`), `tpc_commit` (`TNS_TPC_TXN_COMMIT`) and
/// `tpc_rollback` (`TNS_TPC_TXN_ABORT`). `requested_state` is the desired state
/// (0 for prepare; READ_ONLY/COMMITTED for commit; ABORTED for rollback).
/// Reference messages/tpc_change_state.pyx `_write_message`.
pub fn build_tpc_change_state_payload_with_seq(
    seq_num: u8,
    operation: u32,
    requested_state: u32,
    flags: u32,
    xid: Option<&TpcXid<'_>>,
    context: Option<&[u8]>,
) -> Vec<u8> {
    let mut writer = TtcWriter::new();
    writer.write_function_code_with_seq(TNS_FUNC_TPC_TXN_CHANGE_STATE, seq_num);
    writer.write_ub8(0); // token
    writer.write_ub4(operation);
    match context {
        Some(context) => {
            writer.write_u8(1); // pointer (context)
            writer.write_ub4(u32::try_from(context.len()).unwrap_or(0));
        }
        None => {
            writer.write_u8(0); // pointer (context)
            writer.write_ub4(0); // context length
        }
    }
    write_xid_descriptor(&mut writer, xid);
    writer.write_ub4(0); // timeout (always 0)
    writer.write_ub4(requested_state);
    writer.write_u8(1); // pointer (out state)
    writer.write_ub4(flags);
    if let Some(context) = context {
        writer.write_raw(context);
    }
    if let Some(xid) = xid {
        write_xid_block_bytes(&mut writer, xid);
    }
    writer.into_bytes()
}

/// Parse a full-XA transaction-switch response (reference tpc_switch.pyx
/// `_process_return_parameters` plus the base.pyx message loop). Captures the
/// returned transaction context (PARAMETER message) and the txn-in-progress bit
/// (last call status). Server errors are surfaced as `ProtocolError`.
pub fn parse_tpc_switch_response(
    payload: &[u8],
    capabilities: ClientCapabilities,
) -> Result<TpcSwitchResponse> {
    let mut reader = TtcReader::new(payload);
    let mut response = TpcSwitchResponse::default();
    while reader.remaining() > 0 {
        let message_type = reader.read_u8()?;
        match message_type {
            0 => {}
            TNS_MSG_TYPE_STATUS => {
                let call_status = reader.read_ub4()?;
                let _seq = reader.read_ub2()?;
                response.txn_in_progress = call_status & TNS_EOCS_FLAGS_TXN_IN_PROGRESS != 0;
            }
            TNS_MSG_TYPE_PARAMETER => {
                // tpc_switch.pyx `_process_return_parameters`: application value
                // (ub4) then the return transaction context (ub2 length + bytes).
                let _application_value = reader.read_ub4()?;
                let context_len = reader.read_ub2()?;
                let context = reader.read_raw(usize::from(context_len))?;
                response.context = context.to_vec();
            }
            TNS_MSG_TYPE_SERVER_SIDE_PIGGYBACK => {
                if let Some(update) = skip_server_side_piggyback(&mut reader)? {
                    response.sessionless_state = Some(update);
                }
            }
            TNS_MSG_TYPE_END_OF_RESPONSE => break,
            TNS_MSG_TYPE_ERROR => {
                let info = parse_server_error_info(&mut reader, capabilities.ttc_field_version)?;
                if info.number != 0 {
                    // On a server error the reference raises before
                    // `_process_call_status` runs, so `_txn_in_progress` keeps
                    // its prior value; we surface the error without touching the
                    // flag.
                    return Err(ProtocolError::ServerErrorInfo(Box::new(
                        info.into_details(),
                    )));
                }
                // The end-of-call ERROR (number 0 on success) carries the
                // end-of-call status; sample the transaction-in-progress bit.
                response.txn_in_progress = info.call_status & TNS_EOCS_FLAGS_TXN_IN_PROGRESS != 0;
            }
            _ => break,
        }
    }
    Ok(response)
}

/// Parse a TPC change-state response (reference tpc_change_state.pyx
/// `_process_return_parameters` plus the base.pyx message loop). Reads the out
/// state from the PARAMETER message and the txn-in-progress bit from the last
/// call status. Server errors are surfaced as `ProtocolError`.
pub fn parse_tpc_change_state_response(
    payload: &[u8],
    capabilities: ClientCapabilities,
) -> Result<TpcChangeStateResponse> {
    let mut reader = TtcReader::new(payload);
    let mut response = TpcChangeStateResponse::default();
    while reader.remaining() > 0 {
        let message_type = reader.read_u8()?;
        match message_type {
            0 => {}
            TNS_MSG_TYPE_STATUS => {
                let call_status = reader.read_ub4()?;
                let _seq = reader.read_ub2()?;
                response.txn_in_progress = call_status & TNS_EOCS_FLAGS_TXN_IN_PROGRESS != 0;
            }
            TNS_MSG_TYPE_PARAMETER => {
                // tpc_change_state.pyx `_process_return_parameters` reads the
                // out state (ub4).
                response.state = reader.read_ub4()?;
            }
            TNS_MSG_TYPE_SERVER_SIDE_PIGGYBACK => {
                skip_server_side_piggyback(&mut reader)?;
            }
            TNS_MSG_TYPE_END_OF_RESPONSE => break,
            TNS_MSG_TYPE_ERROR => {
                let info = parse_server_error_info(&mut reader, capabilities.ttc_field_version)?;
                if info.number != 0 {
                    // On a server error the reference raises before
                    // `_process_call_status` runs, so `_txn_in_progress` keeps
                    // its prior value; we surface the error without touching the
                    // flag.
                    return Err(ProtocolError::ServerErrorInfo(Box::new(
                        info.into_details(),
                    )));
                }
                // The end-of-call ERROR (number 0 on success) carries the
                // end-of-call status; sample the transaction-in-progress bit.
                response.txn_in_progress = info.call_status & TNS_EOCS_FLAGS_TXN_IN_PROGRESS != 0;
            }
            _ => break,
        }
    }
    Ok(response)
}

pub(crate) fn skip_keyword_value_pairs(reader: &mut TtcReader<'_>, num_pairs: u16) -> Result<()> {
    read_keyword_value_pairs_for_txn_state(reader, num_pairs).map(|_| ())
}

/// Like [`skip_keyword_value_pairs`] but extracts the sessionless transaction
/// state carried by the `TRANSACTION_ID` keyword (201). Reference
/// `_process_keyword_value_pairs` calls `_update_sessionless_txn_state` on the
/// binary value of that keyword.
pub(crate) fn read_keyword_value_pairs_for_txn_state(
    reader: &mut TtcReader<'_>,
    num_pairs: u16,
) -> Result<Option<SessionlessTxnState>> {
    let mut state = None;
    for _ in 0..num_pairs {
        if reader.read_ub2()? > 0 {
            let _text_value = reader.read_bytes()?;
        }
        let mut binary_value = None;
        if reader.read_ub2()? > 0 {
            binary_value = reader.read_bytes()?;
        }
        let keyword_num = reader.read_ub2()?;
        if keyword_num == TNS_KEYWORD_NUM_TRANSACTION_ID {
            if let Some(binary) = binary_value.as_deref() {
                if let Some(update) = decode_sessionless_txn_state(binary)? {
                    state = Some(update);
                }
            }
        }
    }
    Ok(state)
}

#[cfg(test)]
mod tpc_tests {
    use super::*;

    fn xid() -> ([u8; 7], [u8; 8]) {
        (*b"txn4400", *b"branchId")
    }

    #[test]
    fn tpc_begin_payload_encodes_format_branch_and_128_byte_xid() {
        let (gtid, bqual) = xid();
        let tpc_xid = TpcXid {
            format_id: 4400,
            global_transaction_id: &gtid,
            branch_qualifier: &bqual,
        };
        let payload = build_tpc_switch_payload_with_seq(
            4,
            TNS_TPC_TXN_START,
            TPC_TXN_FLAGS_NEW,
            0,
            Some(&tpc_xid),
            None,
        );
        // [msg_type=3][func=0x67=103][seq=4] + token ub8(0) = 1 byte
        assert_eq!(&payload[..3], &[3, TNS_FUNC_TPC_TXN_SWITCH, 4]);
        let body = &payload[4..];
        // operation ub4(START=1) = [1,1]; context ptr u8(0) = [0]; len ub4(0) = [0]
        assert_eq!(&body[..4], &[1, 1, 0, 0]);
        // format id ub4(4400=0x1130) = len2 + value (golden: 02 11 30)
        assert_eq!(&body[4..7], &[2, 0x11, 0x30]);
        // gtid len ub4(7)=[1,7], bqual len ub4(8)=[1,8], xid ptr u8(1)=[1],
        // block len ub4(128)=[1,0x80]
        assert_eq!(&body[7..14], &[1, 7, 1, 8, 1, 1, 0x80]);
        // the 128-byte xid block must contain gtid+bqual zero-padded; it is the
        // last 128 bytes before the trailing application value ub4(0) = [0].
        let block_start = payload.len() - 128 - 1;
        let block = &payload[block_start..block_start + 128];
        assert_eq!(&block[..7], b"txn4400");
        assert_eq!(&block[7..15], b"branchId");
        assert!(block[15..].iter().all(|&byte| byte == 0));
    }

    #[test]
    fn tpc_end_payload_echoes_context() {
        let context = vec![0xAAu8; 168];
        let payload =
            build_tpc_switch_payload_with_seq(7, TNS_TPC_TXN_DETACH, 0, 0, None, Some(&context));
        let body = &payload[4..];
        // operation ub4(DETACH=2)=[1,2]; context ptr u8(1)=[1]; len ub4(168)=[1,0xA8]
        assert_eq!(&body[..5], &[1, 2, 1, 1, 0xA8]);
        // context bytes are echoed verbatim somewhere in the payload tail
        assert!(payload
            .windows(context.len())
            .any(|window| window == context.as_slice()));
    }

    #[test]
    fn change_state_prepare_payload_shape() {
        let (gtid, bqual) = xid();
        let tpc_xid = TpcXid {
            format_id: 4400,
            global_transaction_id: &gtid,
            branch_qualifier: &bqual,
        };
        let payload = build_tpc_change_state_payload_with_seq(
            8,
            TNS_TPC_TXN_PREPARE,
            TNS_TPC_TXN_STATE_PREPARE,
            0,
            Some(&tpc_xid),
            None,
        );
        assert_eq!(&payload[..3], &[3, TNS_FUNC_TPC_TXN_CHANGE_STATE, 8]);
        let body = &payload[4..];
        // operation ub4(PREPARE=3)=[1,3]; context ptr u8(0)=[0]; len ub4(0)=[0]
        assert_eq!(&body[..4], &[1, 3, 0, 0]);
    }

    #[test]
    fn switch_response_captures_context_and_txn_bit() {
        // PARAMETER(8): app_value ub4(0) + context_len ub2(4) + 4 context bytes;
        // STATUS(9): call_status ub4 = 3 (TXN bit set) + seq ub2(0); EOR(29).
        let mut payload = Vec::new();
        payload.push(TNS_MSG_TYPE_PARAMETER);
        payload.push(0); // app value ub4(0)
        payload.extend_from_slice(&[2, 0, 4]); // context_len ub2 = 4
        payload.extend_from_slice(&[0xDE, 0xAD, 0xBE, 0xEF]);
        payload.push(TNS_MSG_TYPE_STATUS);
        payload.extend_from_slice(&[1, 3]); // call_status ub4 = 3
        payload.extend_from_slice(&[0]); // seq ub2 = 0
        payload.push(TNS_MSG_TYPE_END_OF_RESPONSE);

        let response =
            parse_tpc_switch_response(&payload, ClientCapabilities::default()).expect("decode");
        assert_eq!(response.context, vec![0xDE, 0xAD, 0xBE, 0xEF]);
        assert!(response.txn_in_progress);
    }

    #[test]
    fn switch_response_end_status_clears_txn_bit() {
        // STATUS call_status = 1 (TXN bit clear) -> txn_in_progress == false.
        let mut payload = Vec::new();
        payload.push(TNS_MSG_TYPE_STATUS);
        payload.extend_from_slice(&[1, 1]); // call_status ub4 = 1
        payload.extend_from_slice(&[0]); // seq ub2 = 0
        payload.push(TNS_MSG_TYPE_END_OF_RESPONSE);

        let response =
            parse_tpc_switch_response(&payload, ClientCapabilities::default()).expect("decode");
        assert!(!response.txn_in_progress);
    }

    #[test]
    fn change_state_response_reads_out_state() {
        // PARAMETER out state ub4 = 1 (REQUIRES_COMMIT); STATUS txn bit clear.
        let mut payload = Vec::new();
        payload.push(TNS_MSG_TYPE_PARAMETER);
        payload.extend_from_slice(&[1, 1]); // state ub4 = 1
        payload.push(TNS_MSG_TYPE_STATUS);
        payload.extend_from_slice(&[1, 1]); // call_status ub4 = 1
        payload.extend_from_slice(&[0]); // seq ub2 = 0
        payload.push(TNS_MSG_TYPE_END_OF_RESPONSE);

        let response = parse_tpc_change_state_response(&payload, ClientCapabilities::default())
            .expect("decode");
        assert_eq!(response.state, TNS_TPC_TXN_STATE_REQUIRES_COMMIT);
        assert!(!response.txn_in_progress);
    }
}