wp-knowledge 0.11.6

KnowDB loader and SQLite-backed query facade for the Warp Parse stack.
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
use orion_error::ErrorOwe;
use rusqlite::Params;
use std::collections::hash_map::DefaultHasher;
use std::future::Future;
use std::hash::{Hash, Hasher};
use std::num::NonZeroUsize;
use std::sync::{Arc, RwLock};
use wp_error::KnowledgeResult;
use wp_log::debug_kdb;
use wp_model_core::model::{self, DataField};

use lazy_static::lazy_static;
use lru::LruCache;

use crate::loader::ProviderKind;
use crate::mem::RowData;
use crate::runtime::{DatasourceId, Generation, MetadataCacheScope, runtime};
use crate::telemetry::{
    CacheLayer, CacheOutcome, CacheTelemetryEvent, telemetry, telemetry_enabled,
};

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct MetadataCacheKey {
    pub datasource_id: DatasourceId,
    pub generation: Generation,
    pub query_hash: u64,
}

lazy_static! {
    /// Global column metadata cache keyed by datasource/generation/query hash.
    pub static ref COLNAME_CACHE: RwLock<LruCache<MetadataCacheKey, Arc<Vec<String>>>> =
        RwLock::new(LruCache::new(
            NonZeroUsize::new(512).expect("non-zero metadata cache size")
        ));
}

pub fn column_metadata_cache_snapshot() -> (usize, usize) {
    COLNAME_CACHE
        .read()
        .map(|cache| (cache.len(), cache.cap().get()))
        .unwrap_or((0, 0))
}

fn stable_hash(value: &str) -> u64 {
    let mut hasher = DefaultHasher::new();
    value.hash(&mut hasher);
    hasher.finish()
}

#[cfg(test)]
pub(crate) fn metadata_cache_key_for_current_scope(sql: &str) -> MetadataCacheKey {
    let scope = runtime().current_metadata_scope();
    metadata_cache_key_for_scope(&scope, sql)
}

pub(crate) fn metadata_cache_key_for_scope(
    scope: &MetadataCacheScope,
    sql: &str,
) -> MetadataCacheKey {
    MetadataCacheKey {
        datasource_id: scope.datasource_id.clone(),
        generation: scope.generation,
        query_hash: stable_hash(sql),
    }
}

pub(crate) fn metadata_cache_get_or_try_init<F>(sql: &str, load: F) -> KnowledgeResult<Vec<String>>
where
    F: FnOnce() -> KnowledgeResult<Option<Vec<String>>>,
{
    let scope = runtime().current_metadata_scope();
    let provider_kind = runtime().current_provider_kind();
    metadata_cache_get_or_try_init_for_scope(&scope, provider_kind, sql, load)
}

pub(crate) fn metadata_cache_get_or_try_init_for_scope<F>(
    scope: &MetadataCacheScope,
    provider_kind: Option<ProviderKind>,
    sql: &str,
    load: F,
) -> KnowledgeResult<Vec<String>>
where
    F: FnOnce() -> KnowledgeResult<Option<Vec<String>>>,
{
    let cache_key = metadata_cache_key_for_scope(scope, sql);
    if let Some(names) = COLNAME_CACHE
        .read()
        .ok()
        .and_then(|m| m.peek(&cache_key).cloned())
    {
        runtime().record_metadata_cache_hit();
        if telemetry_enabled() {
            telemetry().on_cache(&CacheTelemetryEvent {
                layer: CacheLayer::Metadata,
                outcome: CacheOutcome::Hit,
                provider_kind: provider_kind.clone(),
            });
        }
        debug_kdb!(
            "[kdb] metadata cache hit datasource_id={} generation={}",
            cache_key.datasource_id.0,
            cache_key.generation.0
        );
        return Ok((*names).clone());
    }

    runtime().record_metadata_cache_miss();
    if telemetry_enabled() {
        telemetry().on_cache(&CacheTelemetryEvent {
            layer: CacheLayer::Metadata,
            outcome: CacheOutcome::Miss,
            provider_kind,
        });
    }
    debug_kdb!(
        "[kdb] metadata cache miss datasource_id={} generation={}",
        cache_key.datasource_id.0,
        cache_key.generation.0
    );

    let Some(names) = load()? else {
        return Ok(Vec::new());
    };
    if let Ok(mut m) = COLNAME_CACHE.write() {
        m.put(cache_key, Arc::new(names.clone()));
    }
    Ok(names)
}

pub(crate) async fn metadata_cache_get_or_try_init_async_for_scope<F, Fut>(
    scope: &MetadataCacheScope,
    provider_kind: Option<ProviderKind>,
    sql: &str,
    load: F,
) -> KnowledgeResult<Vec<String>>
where
    F: FnOnce() -> Fut,
    Fut: Future<Output = KnowledgeResult<Option<Vec<String>>>>,
{
    metadata_cache_get_or_try_init_async_for_scope_typed(scope, provider_kind, sql, load).await
}

pub(crate) async fn metadata_cache_get_or_try_init_async_for_scope_typed<F, Fut, E>(
    scope: &MetadataCacheScope,
    provider_kind: Option<ProviderKind>,
    sql: &str,
    load: F,
) -> Result<Vec<String>, E>
where
    F: FnOnce() -> Fut,
    Fut: Future<Output = Result<Option<Vec<String>>, E>>,
{
    let cache_key = metadata_cache_key_for_scope(scope, sql);
    if let Some(names) = COLNAME_CACHE
        .read()
        .ok()
        .and_then(|m| m.peek(&cache_key).cloned())
    {
        runtime().record_metadata_cache_hit();
        if telemetry_enabled() {
            telemetry().on_cache(&CacheTelemetryEvent {
                layer: CacheLayer::Metadata,
                outcome: CacheOutcome::Hit,
                provider_kind: provider_kind.clone(),
            });
        }
        return Ok((*names).clone());
    }

    runtime().record_metadata_cache_miss();
    if telemetry_enabled() {
        telemetry().on_cache(&CacheTelemetryEvent {
            layer: CacheLayer::Metadata,
            outcome: CacheOutcome::Miss,
            provider_kind,
        });
    }

    let Some(names) = load().await? else {
        return Ok(Vec::new());
    };
    if let Ok(mut m) = COLNAME_CACHE.write() {
        m.put(cache_key, Arc::new(names.clone()));
    }
    Ok(names)
}

/// 将一行数据映射为 RowData
fn map_row(row: &rusqlite::Row<'_>, col_names: &[String]) -> KnowledgeResult<RowData> {
    let mut result = Vec::with_capacity(col_names.len());
    for (i, col_name) in col_names.iter().enumerate() {
        let value = row.get_ref(i).owe_rule()?;
        let field = match value {
            rusqlite::types::ValueRef::Null => {
                DataField::new(model::DataType::default(), col_name, model::Value::Null)
            }
            rusqlite::types::ValueRef::Integer(v) => DataField::from_digit(col_name, v),
            rusqlite::types::ValueRef::Real(v) => DataField::from_float(col_name, v),
            rusqlite::types::ValueRef::Text(v) => {
                DataField::from_chars(col_name, String::from_utf8(v.to_vec()).owe_rule()?)
            }
            rusqlite::types::ValueRef::Blob(v) => {
                DataField::from_chars(col_name, String::from_utf8_lossy(v).to_string())
            }
        };
        result.push(field);
    }
    Ok(result)
}

/// 从 statement 获取列名(普通版,带 debug 日志)
fn extract_col_names(stmt: &rusqlite::Statement<'_>) -> Vec<String> {
    let col_cnt = stmt.column_count();
    debug_kdb!("[memdb] col_cnt={}", col_cnt);
    let mut col_names = Vec::with_capacity(col_cnt);
    for i in 0..col_cnt {
        let name = stmt.column_name(i).unwrap_or("").to_string();
        debug_kdb!("[memdb] col[{}] name='{}'", i, name);
        col_names.push(name);
    }
    col_names
}

/// 从 statement 获取列名(cached 版,使用全局缓存)
fn extract_col_names_cached(
    stmt: &rusqlite::Statement<'_>,
    sql: &str,
) -> KnowledgeResult<Vec<String>> {
    metadata_cache_get_or_try_init(sql, || {
        let col_cnt = stmt.column_count();
        let mut names = Vec::with_capacity(col_cnt);
        for i in 0..col_cnt {
            names.push(stmt.column_name(i).owe_rule()?.to_string());
        }
        Ok(Some(names))
    })
}

fn extract_col_names_cached_with_scope(
    stmt: &rusqlite::Statement<'_>,
    scope: &MetadataCacheScope,
    provider_kind: Option<ProviderKind>,
    sql: &str,
) -> KnowledgeResult<Vec<String>> {
    metadata_cache_get_or_try_init_for_scope(scope, provider_kind, sql, || {
        let col_cnt = stmt.column_count();
        let mut names = Vec::with_capacity(col_cnt);
        for i in 0..col_cnt {
            names.push(stmt.column_name(i).owe_rule()?.to_string());
        }
        Ok(Some(names))
    })
}

pub fn query<P: Params>(
    conn: &rusqlite::Connection,
    sql: &str,
    params: P,
) -> KnowledgeResult<Vec<RowData>> {
    let mut stmt = conn.prepare_cached(sql).owe_rule()?;
    let col_names = extract_col_names(&stmt);
    let mut rows = stmt.query(params).owe_rule()?;
    let mut all_result = Vec::new();
    while let Some(row) = rows.next().owe_rule()? {
        all_result.push(map_row(row, &col_names)?);
    }
    Ok(all_result)
}

/// Query first row and map columns into RowData with column names preserved.
pub fn query_first_row<P: Params>(
    conn: &rusqlite::Connection,
    sql: &str,
    params: P,
) -> KnowledgeResult<RowData> {
    let mut stmt = conn.prepare_cached(sql).owe_rule()?;
    let col_names = extract_col_names(&stmt);
    let mut rows = stmt.query(params).owe_rule()?;
    if let Some(row) = rows.next().owe_rule()? {
        map_row(row, &col_names)
    } else {
        debug_kdb!("[memdb] no row for sql");
        Ok(Vec::new())
    }
}

pub fn query_cached<P: Params>(
    conn: &rusqlite::Connection,
    sql: &str,
    params: P,
) -> KnowledgeResult<Vec<RowData>> {
    let mut stmt = conn.prepare_cached(sql).owe_rule()?;
    // Column names cache (per SQL)
    let col_names = extract_col_names_cached(&stmt, sql)?;
    let mut rows = stmt.query(params).owe_rule()?;
    let mut all_result = Vec::new();
    while let Some(row) = rows.next().owe_rule()? {
        all_result.push(map_row(row, &col_names)?);
    }
    Ok(all_result)
}

pub fn query_cached_with_scope<P: Params>(
    conn: &rusqlite::Connection,
    scope: &MetadataCacheScope,
    provider_kind: Option<ProviderKind>,
    sql: &str,
    params: P,
) -> KnowledgeResult<Vec<RowData>> {
    let mut stmt = conn.prepare_cached(sql).owe_rule()?;
    let col_names = extract_col_names_cached_with_scope(&stmt, scope, provider_kind, sql)?;
    let mut rows = stmt.query(params).owe_rule()?;
    let mut all_result = Vec::new();
    while let Some(row) = rows.next().owe_rule()? {
        all_result.push(map_row(row, &col_names)?);
    }
    Ok(all_result)
}

/// Same as `query_first_row` but with a shared column-names cache to reduce metadata lookups.
pub fn query_first_row_cached<P: Params>(
    conn: &rusqlite::Connection,
    sql: &str,
    params: P,
) -> KnowledgeResult<RowData> {
    let mut stmt = conn.prepare_cached(sql).owe_rule()?;
    let col_names = extract_col_names_cached(&stmt, sql)?;
    let mut rows = stmt.query(params).owe_rule()?;
    if let Some(row) = rows.next().owe_rule()? {
        map_row(row, &col_names)
    } else {
        Ok(Vec::new())
    }
}

pub fn query_first_row_cached_with_scope<P: Params>(
    conn: &rusqlite::Connection,
    scope: &MetadataCacheScope,
    provider_kind: Option<ProviderKind>,
    sql: &str,
    params: P,
) -> KnowledgeResult<RowData> {
    let mut stmt = conn.prepare_cached(sql).owe_rule()?;
    let col_names = extract_col_names_cached_with_scope(&stmt, scope, provider_kind, sql)?;
    let mut rows = stmt.query(params).owe_rule()?;
    if let Some(row) = rows.next().owe_rule()? {
        map_row(row, &col_names)
    } else {
        Ok(Vec::new())
    }
}

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

    fn setup_test_db() -> Connection {
        let conn = Connection::open_in_memory().unwrap();
        conn.execute(
            "CREATE TABLE test (id INTEGER, name TEXT, score REAL, data BLOB, empty)",
            [],
        )
        .unwrap();
        conn
    }

    #[test]
    fn test_query_returns_all_rows() {
        let conn = setup_test_db();
        let rows = query(&conn, "SELECT * FROM test", []).unwrap();
        assert!(rows.is_empty());
        conn.execute("INSERT INTO test (id, name) VALUES (1, 'alice')", [])
            .unwrap();
        conn.execute("INSERT INTO test (id, name) VALUES (2, 'bob')", [])
            .unwrap();
        conn.execute("INSERT INTO test (id, name) VALUES (3, 'charlie')", [])
            .unwrap();

        let rows = query(&conn, "SELECT id, name FROM test ORDER BY id", []).unwrap();
        assert_eq!(rows.len(), 3);
    }

    #[test]
    fn test_query_first_row_returns_single_row() {
        let conn = setup_test_db();
        let row = query_first_row(&conn, "SELECT * FROM test", []).unwrap();
        assert!(row.is_empty());
        conn.execute("INSERT INTO test (id, name) VALUES (1, 'first')", [])
            .unwrap();
        conn.execute("INSERT INTO test (id, name) VALUES (2, 'second')", [])
            .unwrap();

        let row = query_first_row(&conn, "SELECT id, name FROM test ORDER BY id", []).unwrap();
        assert_eq!(row.len(), 2);
        assert_eq!(row[0].to_string(), "digit(1)");
        assert_eq!(row[1].to_string(), "chars(first)");
    }

    #[test]
    fn test_map_row_handles_all_types() {
        let conn = setup_test_db();
        conn.execute(
            "INSERT INTO test (id, name, score, data, empty) VALUES (42, 'hello', 3.14, X'414243', NULL)",
            [],
        )
        .unwrap();

        let row =
            query_first_row(&conn, "SELECT id, name, score, data, empty FROM test", []).unwrap();
        assert_eq!(row.len(), 5);
    }

    #[test]
    fn test_extract_col_names_preserves_aliases() {
        let conn = setup_test_db();
        conn.execute("INSERT INTO test (id, name) VALUES (1, 'x')", [])
            .unwrap();

        let row = query_first_row(
            &conn,
            "SELECT id AS user_id, name AS user_name FROM test",
            [],
        )
        .unwrap();
        assert_eq!(row[0].get_name(), "user_id");
        assert_eq!(row[1].get_name(), "user_name");
    }

    #[test]
    fn test_query_cached_uses_cache() {
        let _guard = crate::runtime::runtime_test_guard()
            .lock()
            .expect("runtime test guard");
        let conn = setup_test_db();
        conn.execute("INSERT INTO test (id) VALUES (1)", [])
            .unwrap();

        let sql = "SELECT id FROM test WHERE id = 1";
        // 第一次查询,填充缓存
        let _ = query_cached(&conn, sql, []).unwrap();
        // 第二次查询,应命中缓存
        let rows = query_cached(&conn, sql, []).unwrap();
        assert_eq!(rows.len(), 1);

        // 验证缓存已填充
        let cache = COLNAME_CACHE.read().unwrap();
        assert!(cache.contains(&metadata_cache_key_for_current_scope(sql)));
    }

    #[test]
    fn test_query_with_params() {
        let conn = setup_test_db();
        conn.execute("INSERT INTO test (id, name) VALUES (1, 'alice')", [])
            .unwrap();
        conn.execute("INSERT INTO test (id, name) VALUES (2, 'bob')", [])
            .unwrap();

        let rows = query(&conn, "SELECT name FROM test WHERE id = ?1", [2]).unwrap();
        assert_eq!(rows.len(), 1);
        assert_eq!(rows[0][0].to_string(), "chars(bob)");
    }

    #[test]
    fn test_metadata_cache_key_for_scope_is_explicit() {
        let sql = "SELECT id FROM test";
        let scope_a = MetadataCacheScope {
            datasource_id: DatasourceId("postgres:aaaa".to_string()),
            generation: Generation(1),
        };
        let scope_b = MetadataCacheScope {
            datasource_id: DatasourceId("postgres:bbbb".to_string()),
            generation: Generation(2),
        };
        let key_a = metadata_cache_key_for_scope(&scope_a, sql);
        let key_b = metadata_cache_key_for_scope(&scope_b, sql);
        assert_ne!(key_a, key_b);
    }
}