kape-postgres 0.1.2

PostgreSQL backend adapter for Kape.
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
use std::{
    hash::Hash,
    marker::PhantomData,
    sync::Arc,
    time::{SystemTime, UNIX_EPOCH},
};

use async_trait::async_trait;
use kape::{CacheBackend, CacheEntry, KapeResult, SetItem, validate_set_items};
use sqlx::{AssertSqlSafe, PgPool, Postgres, Row, Transaction};

use crate::mutation::{MutationPlan, MutationPlanner, PlannedSet, PlannedUpsert};
use crate::{PostgresBackendError, PostgresCodec, PostgresKey, PostgresValue, StringCodec, codec};

/// A PostgreSQL-backed cache adapter.
pub struct PostgresBackend<K = String, V = String, C = StringCodec> {
    pool: PgPool,
    codec: C,
    table: String,
    namespace: String,
    marker: PhantomData<fn(K, V)>,
}

impl<K, V, C> Clone for PostgresBackend<K, V, C>
where
    C: Clone,
{
    fn clone(&self) -> Self {
        Self {
            pool: self.pool.clone(),
            codec: self.codec.clone(),
            table: self.table.clone(),
            namespace: self.namespace.clone(),
            marker: PhantomData,
        }
    }
}

impl<K, V> PostgresBackend<K, V> {
    /// Creates an adapter using the application-owned `kape_entries` table.
    #[must_use]
    pub fn new(pool: PgPool) -> Self {
        Self {
            pool,
            codec: StringCodec,
            table: "\"kape_entries\"".to_owned(),
            namespace: String::new(),
            marker: PhantomData,
        }
    }
}

impl<K, V, C> PostgresBackend<K, V, C> {
    /// Replaces the key/value codec.
    #[must_use]
    pub fn with_codec<D>(self, codec: D) -> PostgresBackend<K, V, D>
    where
        D: PostgresCodec<K, V>,
    {
        PostgresBackend {
            pool: self.pool,
            codec,
            table: self.table,
            namespace: self.namespace,
            marker: PhantomData,
        }
    }

    /// Selects a validated `table` or `schema.table` identifier.
    ///
    /// # Errors
    ///
    /// Returns an error for unsafe or unsupported identifiers.
    pub fn with_table(mut self, table: &str) -> KapeResult<Self> {
        self.table = validate_table_name(table)
            .ok_or_else(|| PostgresBackendError::InvalidTableName(table.to_owned()))?;
        Ok(self)
    }

    /// Sets the caller-owned namespace.
    #[must_use]
    pub fn namespace(mut self, namespace: impl Into<String>) -> Self {
        self.namespace = namespace.into();
        self
    }
}

impl<K, V, C> PostgresBackend<K, V, C>
where
    C: PostgresCodec<K, V>,
{
    fn namespace_prefix(&self) -> C::EncodedKey {
        C::EncodedKey::namespace_prefix(&self.namespace)
    }

    fn encode_key(&self, key: &K) -> Result<C::EncodedKey, PostgresBackendError> {
        codec::encode_namespaced_key(&self.codec, &self.namespace, key)
    }

    /// Deletes expired rows owned by this namespace.
    ///
    /// The application remains responsible for scheduling this operation and
    /// for table-wide maintenance.
    ///
    /// # Errors
    ///
    /// Returns a backend error when `PostgreSQL` rejects the operation.
    pub async fn purge_expired(&self) -> KapeResult<u64> {
        let prefix = self.namespace_prefix();
        let statement = format!(
            "DELETE FROM {} \
             WHERE substring(key from 1 for length($1)) = $1 \
             AND expires_at_ms IS NOT NULL \
             AND expires_at_ms <= (EXTRACT(EPOCH FROM clock_timestamp()) * 1000)::BIGINT",
            self.table
        );
        let result = sqlx::query(AssertSqlSafe(statement))
            .bind(prefix)
            .execute(&self.pool)
            .await
            .map_err(PostgresBackendError::Sqlx)?;
        Ok(result.rows_affected())
    }
}

#[async_trait]
impl<K, V, C> CacheBackend<K, V> for PostgresBackend<K, V, C>
where
    K: Send + Sync,
    V: Send + Sync,
    C: PostgresCodec<K, V>,
{
    async fn get(&self, key: &K) -> KapeResult<Option<CacheEntry<V>>> {
        let key = self.encode_key(key)?;
        let statement = format!(
            "SELECT value, CASE WHEN expires_at_ms IS NULL THEN NULL \
             ELSE expires_at_ms - (EXTRACT(EPOCH FROM clock_timestamp()) * 1000)::BIGINT \
             END AS remaining_ms FROM {} WHERE key = $1",
            self.table
        );
        let Some(row) = sqlx::query(AssertSqlSafe(statement))
            .bind(key)
            .fetch_optional(&self.pool)
            .await
            .map_err(PostgresBackendError::Sqlx)?
        else {
            return Ok(None);
        };
        let value: C::EncodedValue = row.try_get("value").map_err(PostgresBackendError::Sqlx)?;
        let remaining_ms: Option<i64> = row
            .try_get("remaining_ms")
            .map_err(PostgresBackendError::Sqlx)?;
        crate::lookup::decode_lookup(&self.codec, Some(value), remaining_ms).map_err(Into::into)
    }

    async fn set(&self, key: &K, value: Arc<V>, ttl: i64) -> KapeResult<()> {
        let now_ms = (ttl > 0).then(unix_now_ms).transpose()?;
        let planner = MutationPlanner::new(&self.codec, &self.namespace);
        match planner.plan_set(key, value.as_ref(), ttl, now_ms)? {
            PlannedSet::Upsert(plan) => upsert(&self.pool, &self.table, plan).await,
            PlannedSet::Delete(key) => delete_one(&self.pool, &self.table, key).await,
        }
    }

    async fn remove(&self, key: &K) -> KapeResult<()> {
        let key = self.encode_key(key)?;
        delete_one(&self.pool, &self.table, key).await
    }

    async fn get_many(&self, keys: &[&K]) -> KapeResult<Vec<Option<CacheEntry<V>>>> {
        if keys.is_empty() {
            return Ok(Vec::new());
        }
        let keys = keys
            .iter()
            .map(|key| self.encode_key(key))
            .collect::<Result<Vec<_>, _>>()?;
        let statement = format!(
            "WITH requested(key, ord) AS (\
             SELECT * FROM UNNEST($1) WITH ORDINALITY\
             ) SELECT entries.value, CASE WHEN entries.expires_at_ms IS NULL THEN NULL \
             ELSE entries.expires_at_ms - \
             (EXTRACT(EPOCH FROM clock_timestamp()) * 1000)::BIGINT END AS remaining_ms \
             FROM requested LEFT JOIN {} AS entries ON entries.key = requested.key \
             ORDER BY requested.ord",
            self.table
        );
        let rows = sqlx::query(AssertSqlSafe(statement))
            .bind(keys)
            .fetch_all(&self.pool)
            .await
            .map_err(PostgresBackendError::Sqlx)?;
        rows.into_iter()
            .map(|row| {
                let value: Option<C::EncodedValue> =
                    row.try_get("value").map_err(PostgresBackendError::Sqlx)?;
                let remaining_ms: Option<i64> = row
                    .try_get("remaining_ms")
                    .map_err(PostgresBackendError::Sqlx)?;
                crate::lookup::decode_lookup(&self.codec, value, remaining_ms)
            })
            .collect::<Result<Vec<_>, PostgresBackendError>>()
            .map_err(Into::into)
    }

    async fn set_many(&self, items: &[SetItem<&K, V>]) -> KapeResult<()>
    where
        K: Eq + Hash,
    {
        validate_set_items(items)?;
        if items.is_empty() {
            return Ok(());
        }

        let now_ms = items
            .iter()
            .any(|item| item.ttl > 0)
            .then(unix_now_ms)
            .transpose()?;
        let MutationPlan { upserts, deletes } =
            MutationPlanner::new(&self.codec, &self.namespace).plan_many(items, now_ms)?;

        match (upserts.is_empty(), deletes.is_empty()) {
            (false, true) => upsert_many(&self.pool, &self.table, upserts).await,
            (true, false) => delete_many(&self.pool, &self.table, deletes).await,
            (false, false) => {
                let mut transaction = self
                    .pool
                    .begin()
                    .await
                    .map_err(PostgresBackendError::Sqlx)?;
                upsert_many_in_transaction(&mut transaction, &self.table, upserts).await?;
                delete_many_in_transaction(&mut transaction, &self.table, deletes).await?;
                transaction
                    .commit()
                    .await
                    .map_err(PostgresBackendError::Sqlx)?;
                Ok(())
            }
            (true, true) => Ok(()),
        }
    }

    async fn remove_many(&self, keys: &[&K]) -> KapeResult<()> {
        if keys.is_empty() {
            return Ok(());
        }
        let keys = keys
            .iter()
            .map(|key| self.encode_key(key))
            .collect::<Result<Vec<_>, _>>()?;
        delete_many(&self.pool, &self.table, keys).await
    }

    async fn clear(&self) -> KapeResult<()> {
        let prefix = self.namespace_prefix();
        let statement = format!(
            "DELETE FROM {} WHERE substring(key from 1 for length($1)) = $1",
            self.table
        );
        sqlx::query(AssertSqlSafe(statement))
            .bind(prefix)
            .execute(&self.pool)
            .await
            .map_err(PostgresBackendError::Sqlx)?;
        Ok(())
    }
}

/// Returns the application host's current Unix timestamp in milliseconds.
fn unix_now_ms() -> Result<i64, PostgresBackendError> {
    let elapsed = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .map_err(PostgresBackendError::SystemClockBeforeUnixEpoch)?;
    i64::try_from(elapsed.as_millis()).map_err(|_| PostgresBackendError::TimestampOverflow)
}

async fn upsert<K, V>(pool: &PgPool, table: &str, upsert: PlannedUpsert<K, V>) -> KapeResult<()>
where
    K: PostgresValue,
    V: PostgresValue,
{
    let PlannedUpsert {
        key,
        value,
        expires_at_ms,
    } = upsert;
    let statement = upsert_statement(table);
    sqlx::query(AssertSqlSafe(statement))
        .bind(key)
        .bind(value)
        .bind(expires_at_ms)
        .execute(pool)
        .await
        .map_err(PostgresBackendError::Sqlx)?;
    Ok(())
}

async fn upsert_many<K, V>(
    pool: &PgPool,
    table: &str,
    upserts: Vec<PlannedUpsert<K, V>>,
) -> KapeResult<()>
where
    K: PostgresValue,
    V: PostgresValue,
{
    let statement = upsert_many_statement::<K, V>(table);
    let (keys, values, expires_at_ms) = sql_upsert_arrays(upserts);
    sqlx::query(AssertSqlSafe(statement))
        .bind(keys)
        .bind(values)
        .bind(expires_at_ms)
        .execute(pool)
        .await
        .map_err(PostgresBackendError::Sqlx)?;
    Ok(())
}

async fn upsert_many_in_transaction<K, V>(
    transaction: &mut Transaction<'_, Postgres>,
    table: &str,
    upserts: Vec<PlannedUpsert<K, V>>,
) -> KapeResult<()>
where
    K: PostgresValue,
    V: PostgresValue,
{
    let statement = upsert_many_statement::<K, V>(table);
    let (keys, values, expires_at_ms) = sql_upsert_arrays(upserts);
    sqlx::query(AssertSqlSafe(statement))
        .bind(keys)
        .bind(values)
        .bind(expires_at_ms)
        .execute(&mut **transaction)
        .await
        .map_err(PostgresBackendError::Sqlx)?;
    Ok(())
}

fn sql_upsert_arrays<K, V>(
    upserts: Vec<PlannedUpsert<K, V>>,
) -> (Vec<K>, Vec<V>, Vec<Option<i64>>) {
    let mut keys = Vec::with_capacity(upserts.len());
    let mut values = Vec::with_capacity(upserts.len());
    let mut expires_at_ms = Vec::with_capacity(upserts.len());
    for upsert in upserts {
        keys.push(upsert.key);
        values.push(upsert.value);
        expires_at_ms.push(upsert.expires_at_ms);
    }
    (keys, values, expires_at_ms)
}

async fn delete_one<K>(pool: &PgPool, table: &str, key: K) -> KapeResult<()>
where
    K: PostgresValue,
{
    let statement = format!("DELETE FROM {table} WHERE key = $1");
    sqlx::query(AssertSqlSafe(statement))
        .bind(key)
        .execute(pool)
        .await
        .map_err(PostgresBackendError::Sqlx)?;
    Ok(())
}

/// Deletes multiple keys.
async fn delete_many<K>(pool: &PgPool, table: &str, keys: Vec<K>) -> KapeResult<()>
where
    K: PostgresValue,
{
    let statement = format!("DELETE FROM {table} WHERE key = ANY($1)");
    sqlx::query(AssertSqlSafe(statement))
        .bind(keys)
        .execute(pool)
        .await
        .map_err(PostgresBackendError::Sqlx)?;
    Ok(())
}

/// Deletes multiple keys in a transaction.
async fn delete_many_in_transaction<K>(
    transaction: &mut Transaction<'_, Postgres>,
    table: &str,
    keys: Vec<K>,
) -> KapeResult<()>
where
    K: PostgresValue,
{
    let statement = format!("DELETE FROM {table} WHERE key = ANY($1)");
    sqlx::query(AssertSqlSafe(statement))
        .bind(keys)
        .execute(&mut **transaction)
        .await
        .map_err(PostgresBackendError::Sqlx)?;
    Ok(())
}

/// Builds an upsert statement for a single key/value pair.
fn upsert_statement(table: &str) -> String {
    format!(
        "INSERT INTO {table} (key, value, expires_at_ms) VALUES ($1, $2, $3) \
         ON CONFLICT (key) DO UPDATE SET value = EXCLUDED.value, \
         expires_at_ms = EXCLUDED.expires_at_ms"
    )
}

fn upsert_many_statement<K, V>(table: &str) -> String
where
    K: PostgresValue,
    V: PostgresValue,
{
    let key_array = K::array_type_name();
    let value_array = V::array_type_name();
    format!(
        "INSERT INTO {table} (key, value, expires_at_ms) \
         SELECT input.key, input.value, input.expires_at_ms \
         FROM UNNEST($1::{key_array}, $2::{value_array}, $3::BIGINT[]) \
         AS input(key, value, expires_at_ms) \
         ON CONFLICT (key) DO UPDATE SET value = EXCLUDED.value, \
         expires_at_ms = EXCLUDED.expires_at_ms"
    )
}

fn validate_table_name(table: &str) -> Option<String> {
    let parts = table.split('.').collect::<Vec<_>>();
    if parts.is_empty() || parts.len() > 2 || !parts.iter().all(|part| valid_identifier(part)) {
        return None;
    }
    Some(
        parts
            .into_iter()
            .map(|part| format!("\"{part}\""))
            .collect::<Vec<_>>()
            .join("."),
    )
}

fn valid_identifier(identifier: &str) -> bool {
    let mut chars = identifier.chars();
    let Some(first) = chars.next() else {
        return false;
    };
    (first == '_' || first.is_ascii_alphabetic())
        && chars.all(|character| character == '_' || character.is_ascii_alphanumeric())
}

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

    #[test]
    fn validates_table_names() {
        assert_eq!(
            validate_table_name("kape_entries").as_deref(),
            Some("\"kape_entries\"")
        );
        assert_eq!(
            validate_table_name("app.kape_entries").as_deref(),
            Some("\"app\".\"kape_entries\"")
        );
        assert_eq!(validate_table_name("bad-name"), None);
        assert_eq!(validate_table_name("public.entries;DROP TABLE users"), None);
        assert_eq!(validate_table_name("a.b.c"), None);
    }
}