halephant-core 0.3.0

A proxy and pooler for Postgres
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
//! Per-client prepared statement state and server-side rewriting.
//!
//! When a server connection is reassigned between clients in
//! transaction-mode pooling, prepared statements from the previous
//! client do not exist on the new server. This module solves the
//! problem by:
//!
//! 1. Intercepting `Parse` messages and assigning canonical names
//!    based on a hash of the query text and parameter types.
//! 2. Maintaining a per-client mapping from client-side names to
//!    canonical names.
//! 3. Tracking which canonical statements each server connection has
//!    prepared. (The per-connection LRU cache lives on
//!    [`crate::connections::server::ServerPrepared`] so it can travel
//!    with the [`crate::connections::server::ServerConn`] it belongs
//!    to.)
//! 4. Transparently re-preparing statements on cache miss.
//!
//! The global, reference-counted store of Parse messages lives in
//! [`crate::pool::prepared::StatementStore`].

use std::collections::HashMap;
use std::sync::Arc;

use futures_util::{SinkExt, StreamExt};
use sha2::{Digest, Sha256};
use tokio::net::TcpStream;
use tokio_util::codec::Framed;

use crate::connections::server::ServerConn;
use crate::pool::PoolManager;
use crate::pool::prepared::StatementStore;
use crate::proto;
use crate::proto::frontend::Parse;

// ---------------------------------------------------------------------------
// Canonical name generation
// ---------------------------------------------------------------------------

/// Compute the canonical name for a query. Exposed for integration
/// tests that need to predict canonical names.
#[doc(hidden)]
pub fn canonical_for_test(query: &str, param_types: &[u32]) -> String {
    canonical_name(query, param_types)
}

/// Compute a canonical statement name from the query text and parameter types.
/// Identical queries produce the same canonical name, enabling deduplication
/// across clients.
fn canonical_name(query: &str, param_types: &[u32]) -> String {
    let mut hasher = Sha256::new();
    hasher.update(query.as_bytes());
    for &oid in param_types {
        hasher.update(oid.to_le_bytes());
    }
    let hash = hasher.finalize();
    format!(
        "_hp_{:016x}",
        u64::from_le_bytes(
            hash[..8]
                .try_into()
                .expect("SHA-256 produces at least 8 bytes"),
        )
    )
}

// ---------------------------------------------------------------------------
// Per-client state
// ---------------------------------------------------------------------------

/// Tracks the client-side → canonical name mapping for a single client session.
#[derive(Default)]
pub struct ClientPrepared {
    /// client statement name → canonical name (includes `""` for unnamed)
    names: HashMap<String, String>,
}

impl ClientPrepared {
    pub fn new() -> Self {
        Self::default()
    }

    /// Register a client-side name for a Parse, returning the canonical name.
    /// Works for both named and unnamed (`""`) statements — unnamed
    /// entries are tracked the same way so `Bind("")` in a subsequent
    /// transaction resolves to the canonical name and gets re-prepared
    /// on a fresh server connection automatically.
    pub fn register(&mut self, parse: &Parse, store: &mut StatementStore) -> String {
        let canon = canonical_name(&parse.query, &parse.param_types);
        match self.names.insert(parse.name.clone(), canon.clone()) {
            Some(ref old_canon) if old_canon == &canon => {
                // Same canonical — no ref-count change needed.
            }
            Some(old_canon) => {
                store.add_ref(canon.clone(), parse.clone());
                store.release(&old_canon);
            }
            None => {
                store.add_ref(canon.clone(), parse.clone());
            }
        }
        canon
    }

    /// Look up the canonical name for a client-side statement name.
    /// Returns `None` if the name isn't tracked (first use, or the
    /// client never sent a `Parse` for it).
    pub fn resolve(&self, client_name: &str) -> Option<&str> {
        self.names.get(client_name).map(String::as_str)
    }

    /// Remove a client-side name mapping (client sent Close for this statement).
    pub fn remove(&mut self, client_name: &str, store: &mut StatementStore) {
        if let Some(canon) = self.names.remove(client_name) {
            store.release(&canon);
        }
    }

    /// Release all references held by this client. Call when the client
    /// disconnects to allow the global store to reclaim memory.
    pub fn release_all(&mut self, store: &mut StatementStore) {
        for canon in self.names.values() {
            store.release(canon);
        }
        self.names.clear();
    }
}

// ---------------------------------------------------------------------------
// Outbound rewriting + server-side preparation
// ---------------------------------------------------------------------------

/// Rewrite outbound (client → server) messages to use canonical prepared
/// statement names. If the server doesn't have a needed statement, prepare it
/// first (including LRU eviction if necessary).
/// Returns `Some(msg)` to forward to server, or `None` if the message was
/// consumed (synthetic response already sent to client).
pub(super) async fn rewrite_outbound(
    msg: proto::frontend::FrontendMessage,
    client_prepared: &mut ClientPrepared,
    server: &mut ServerConn,
    pools: &Arc<PoolManager>,
    client: &mut Framed<TcpStream, proto::codec::FrontendCodec>,
) -> anyhow::Result<Option<proto::frontend::FrontendMessage>> {
    match msg {
        proto::frontend::FrontendMessage::Parse(parse) => {
            let canon = {
                let mut store = pools.stmt_store.lock();
                client_prepared.register(&parse, &mut store)
            };

            ensure_prepared(&canon, server, pools).await?;
            client
                .send(proto::backend::BackendMessage::ParseComplete)
                .await?;
            Ok(None)
        }

        proto::frontend::FrontendMessage::Bind(mut bind) => {
            if let Some(canon) = client_prepared.resolve(&bind.statement) {
                ensure_prepared(canon, server, pools).await?;
                bind.statement = canon.to_owned();
            }
            Ok(Some(proto::frontend::FrontendMessage::Bind(bind)))
        }

        proto::frontend::FrontendMessage::Describe(mut desc) => {
            if desc.kind == proto::frontend::TargetKind::Statement
                && let Some(canon) = client_prepared.resolve(&desc.name)
            {
                ensure_prepared(canon, server, pools).await?;
                desc.name = canon.to_owned();
            }
            Ok(Some(proto::frontend::FrontendMessage::Describe(desc)))
        }

        // Statement Close is handled by handle_close_intercept before
        // reaching here. Portal closes pass through as-is.
        other => Ok(Some(other)),
    }
}

/// Ensure a canonical statement is prepared on the server connection. If the
/// server doesn't have it, send the stored Parse and consume the ParseComplete.
async fn ensure_prepared(
    canon: &str,
    server: &mut ServerConn,
    pools: &Arc<PoolManager>,
) -> anyhow::Result<()> {
    if server.prepared.contains(canon) {
        server.prepared.touch(canon);
        return Ok(());
    }

    // Look up the stored Parse first — bail if missing.
    let stored_parse = {
        let store = pools.stmt_store.lock();
        store.get(canon).cloned()
    };
    let Some(mut parse) = stored_parse else {
        anyhow::bail!("no stored Parse for canonical statement {canon}");
    };

    // Evict if necessary, then prepare.
    if let Some(evicted) = server.prepared.insert(canon.to_owned()) {
        server
            .framed
            .send(proto::frontend::FrontendMessage::Close(
                proto::frontend::Close {
                    kind: proto::frontend::TargetKind::Statement,
                    name: evicted,
                },
            ))
            .await?;
        server
            .framed
            .send(proto::frontend::FrontendMessage::Sync)
            .await?;
        drain_until_ready(&mut server.framed).await?;
    }

    parse.name = canon.to_owned();
    server
        .framed
        .send(proto::frontend::FrontendMessage::Parse(parse))
        .await?;
    server
        .framed
        .send(proto::frontend::FrontendMessage::Sync)
        .await?;
    drain_until_ready(&mut server.framed).await?;

    Ok(())
}

/// Drain server responses until ReadyForQuery, discarding everything except
/// errors (which are propagated).
async fn drain_until_ready(
    framed: &mut Framed<TcpStream, proto::codec::BackendCodec>,
) -> anyhow::Result<()> {
    loop {
        match framed.next().await.transpose()? {
            Some(proto::backend::BackendMessage::ReadyForQuery(_)) => return Ok(()),
            Some(proto::backend::BackendMessage::ErrorResponse(err)) => {
                anyhow::bail!(
                    "server error during prepared statement management: {}",
                    err.message().unwrap_or("unknown")
                );
            }
            Some(_) => {} // ParseComplete, CloseComplete, etc.
            None => anyhow::bail!("upstream closed during prepared statement management"),
        }
    }
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

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

    #[test]
    fn canonical_name_deterministic() {
        let a = canonical_name("SELECT 1", &[]);
        let b = canonical_name("SELECT 1", &[]);
        assert_eq!(a, b);
        assert!(a.starts_with("_hp_"));
    }

    #[test]
    fn canonical_name_differs_by_query() {
        let a = canonical_name("SELECT 1", &[]);
        let b = canonical_name("SELECT 2", &[]);
        assert_ne!(a, b);
    }

    #[test]
    fn canonical_name_differs_by_params() {
        let a = canonical_name("SELECT $1", &[23]); // int4
        let b = canonical_name("SELECT $1", &[25]); // text
        assert_ne!(a, b);
    }

    #[test]
    fn client_register_and_resolve() {
        let mut store = StatementStore::new();
        let mut client = ClientPrepared::new();

        let parse = Parse {
            name: "my_stmt".into(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };

        let canon = client.register(&parse, &mut store);
        assert_eq!(client.resolve("my_stmt"), Some(canon.as_str()));
        assert!(store.get(&canon).is_some());
    }

    #[test]
    fn client_unnamed_tracked() {
        let mut store = StatementStore::new();
        let mut client = ClientPrepared::new();

        let parse = Parse {
            name: String::new(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };

        let canon = client.register(&parse, &mut store);
        assert_eq!(client.resolve(""), Some(canon.as_str()));
        assert!(store.get(&canon).is_some());
    }

    #[test]
    fn client_unnamed_replaced_by_new_parse() {
        let mut store = StatementStore::new();
        let mut client = ClientPrepared::new();

        let parse1 = Parse {
            name: String::new(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };
        let parse2 = Parse {
            name: String::new(),
            query: "SELECT 2".into(),
            param_types: vec![],
        };

        let canon1 = client.register(&parse1, &mut store);
        let canon2 = client.register(&parse2, &mut store);
        assert_ne!(canon1, canon2);

        // The unnamed slot now points to the second query.
        assert_eq!(client.resolve(""), Some(canon2.as_str()));
        // First query's refcount dropped to zero — removed from store.
        assert!(store.get(&canon1).is_none());
        assert!(store.get(&canon2).is_some());
    }

    #[test]
    fn reparse_same_query_does_not_leak_refcount() {
        let mut store = StatementStore::new();
        let mut client = ClientPrepared::new();

        let parse = Parse {
            name: String::new(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };

        let canon = client.register(&parse, &mut store);
        // Re-register the exact same query — refcount must stay at 1.
        client.register(&parse, &mut store);
        client.register(&parse, &mut store);

        // release_all releases one ref — should reach zero.
        client.release_all(&mut store);
        assert!(
            store.get(&canon).is_none(),
            "store entry should be gone after release_all, but refcount leaked"
        );
    }

    #[test]
    fn client_remove() {
        let mut store = StatementStore::new();
        let mut client = ClientPrepared::new();

        let parse = Parse {
            name: "s1".into(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };

        client.register(&parse, &mut store);
        assert!(client.resolve("s1").is_some());
        client.remove("s1", &mut store);
        assert!(client.resolve("s1").is_none());
    }

    #[test]
    fn deduplication_across_clients() {
        let mut store = StatementStore::new();
        let mut client_a = ClientPrepared::new();
        let mut client_b = ClientPrepared::new();

        let parse_a = Parse {
            name: "s1".into(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };
        let parse_b = Parse {
            name: "s1".into(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };

        let canon_a = client_a.register(&parse_a, &mut store);
        let canon_b = client_b.register(&parse_b, &mut store);

        // Same query text → same canonical name.
        assert_eq!(canon_a, canon_b);
    }

    #[test]
    fn no_collision_different_queries_same_client_name() {
        let mut store = StatementStore::new();
        let mut client_a = ClientPrepared::new();
        let mut client_b = ClientPrepared::new();

        let parse_a = Parse {
            name: "s1".into(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };
        let parse_b = Parse {
            name: "s1".into(),
            query: "SELECT 2".into(),
            param_types: vec![],
        };

        let canon_a = client_a.register(&parse_a, &mut store);
        let canon_b = client_b.register(&parse_b, &mut store);

        // Same client name, different queries → different canonical names.
        assert_ne!(canon_a, canon_b);
    }

    #[test]
    fn store_refcount_cleanup() {
        let mut store = StatementStore::new();
        let mut client_a = ClientPrepared::new();
        let mut client_b = ClientPrepared::new();

        let parse = Parse {
            name: "s1".into(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };

        let canon = client_a.register(&parse, &mut store);
        client_b.register(&parse, &mut store);

        // Both clients reference it — store has the entry.
        assert!(store.get(&canon).is_some());

        // Release client A — refcount drops to 1, still in store.
        client_a.release_all(&mut store);
        assert!(store.get(&canon).is_some());

        // Release client B — refcount drops to 0, removed from store.
        client_b.release_all(&mut store);
        assert!(store.get(&canon).is_none());
    }

    #[test]
    fn remove_decrements_refcount() {
        let mut store = StatementStore::new();
        let mut client = ClientPrepared::new();

        let parse = Parse {
            name: "s1".into(),
            query: "SELECT 1".into(),
            param_types: vec![],
        };

        let canon = client.register(&parse, &mut store);
        assert!(store.get(&canon).is_some());

        client.remove("s1", &mut store);
        // Single reference removed — gone from store.
        assert!(store.get(&canon).is_none());
    }
}